My Project
Public Member Functions
ElementContainerMatrix Class Reference

Data container for a set of ElementContainerArray-s and HeaderBase. More...

#include <ElementContainerMatrix.hh>

Inheritance diagram for ElementContainerMatrix:
Inheritance graph
[legend]
Collaboration diagram for ElementContainerMatrix:
Collaboration graph
[legend]

List of all members.

Public Member Functions

 ElementContainerMatrix ()
 Constructor.
 ElementContainerMatrix (HeaderBase pheader)
 Constructor.
 ElementContainerMatrix (const NeutronVector< ElementContainerArray, HeaderBase > &ob)
 This copy constructor is very important from operators in NeutronVector.
ElementContaineroperator() (UInt4 Mindex, UInt4 Aindex)
 Returns the pointer of ElementContainer.
vector< Double > * operator() (UInt4 Mindex, UInt4 Aindex, UInt4 Cindex)
 Returns the pointer of vector<Double> whose index-number is "Key".
vector< Double > * operator() (UInt4 Mindex, UInt4 Aindex, string Key)
 Returns the pointer of vector<Double> whose name is "Key".
 ElementContainerMatrix (const ElementContainerMatrix &ob)
vector< UInt4 > SaveToBinFile (string key, string FileName)
 Histogram data stored in this class are saved as a file in binary data format.
PyObject * SaveToBinFilePy (string key, string FileName)
 This method has the same functionality as "SaveToBinFile(string,string)".
void ReadBinFile (string FileName, vector< UInt4 > dimensions, string key)
 Histogram data stored by SaveToBinFile(string,string) is read with this method, and rebuild ElementContainerMatrix.
void ReadBinFile (string FileName, PyObject *dimensions, string key)
 This method has the same functionality as "ReadBinFile(string,PyObject*,string)".
void AppendErr (string Counts, string Error, Double ErrorValue=0.0)
 This method appends a vector<Double> into each object of ElementContainer.
void AllSum (ElementContainer &res)
 accumulation of all ElementContainers (for S(Q) merging)
ElementContainerMatrix Transpose ()
ElementContainerMatrix Mul (Double d)
ElementContainerMatrixMulMySelf (Double d)
ElementContainerMatrix Mul (Double d, Double e)
ElementContainerMatrixMulMySelf (Double d, Double e)
ElementContainerMatrix Mul (pair< Double, Double > &p)
ElementContainerMatrixMulMySelf (pair< Double, Double > &p)
ElementContainerMatrix Plus (Double d)
ElementContainerMatrixPlusMySelf (Double d)
ElementContainerMatrix Plus (Double d, Double e)
ElementContainerMatrixPlusMySelf (Double d, Double e)
ElementContainerMatrix Plus (pair< Double, Double > &p)
ElementContainerMatrixPlusMySelf (pair< Double, Double > &p)

Detailed Description

Data container for a set of ElementContainerArray-s and HeaderBase.

This class is inherited from the template class, NeutronVector<ElementContainerArray,HeaderBase>. This class is a Data-container class for storeing a set of ElementContainerArray-s and HeaderBase. See the manuals of the template class of NeutronVector<T,H>.


Constructor & Destructor Documentation

Constructor.

This method only calls the constructor of the base class.

Constructor.

This method only calls the constructor of the base class.


Member Function Documentation

void ElementContainerMatrix::AppendErr ( string  Counts,
string  Error,
Double  ErrorValue = 0.0 
)

This method appends a vector<Double> into each object of ElementContainer.

The first argument is the key-name of neutron-counts, and the second is the key-name of its error-value created and appended by this method. The third argument is passed to the constructor of "ElementContainerAppendError", please see the manual of it.

ElementContainer * ElementContainerMatrix::operator() ( UInt4  Mindex,
UInt4  Aindex 
)

Returns the pointer of ElementContainer.

The pointer of ElementContainer is extracted from the object of ElementContainerArray indexed by "Aindex". The pointer of ElementContainerArray is extracted from this class with "Mindex".

vector< Double > * ElementContainerMatrix::operator() ( UInt4  Mindex,
UInt4  Aindex,
UInt4  Cindex 
)

Returns the pointer of vector<Double> whose index-number is "Key".

The pointer of vector<Double> will be obtained from ElementContainer which is extracted with ElementContainer* operator(UInt4,UInt4).

vector< Double > * ElementContainerMatrix::operator() ( UInt4  Mindex,
UInt4  Aindex,
string  Key 
)

Returns the pointer of vector<Double> whose name is "Key".

The pointer of vector<Double> will be obtained from ElementContainer which is extracted with ElementContainer* operator(UInt4,UInt4).

void ElementContainerMatrix::ReadBinFile ( string  FileName,
vector< UInt4 >  dimensions,
string  key 
)

Histogram data stored by SaveToBinFile(string,string) is read with this method, and rebuild ElementContainerMatrix.

This method should be called just after constructing this class method. The binary data will be stored in each ElementContainer with "key".

void ElementContainerMatrix::ReadBinFile ( string  FileName,
PyObject *  dimensions,
string  key 
)

This method has the same functionality as "ReadBinFile(string,PyObject*,string)".

The second argument should be the return value of "SaveToBinFilePy(string,string)".

vector< UInt4 > ElementContainerMatrix::SaveToBinFile ( string  key,
string  FileName 
)

Histogram data stored in this class are saved as a file in binary data format.

Histogram data are extracted from each ElementContainer with "key", and the dimension of ElementContainerArray is written in the type of vector<UInt4> and returned by this method. The return value will be used as the second argument of ReadBinFile(string,vector<UInt4>,string).

PyObject * ElementContainerMatrix::SaveToBinFilePy ( string  key,
string  FileName 
)

This method has the same functionality as "SaveToBinFile(string,string)".

The return value can be recognized by python-environment directory.

This method returns a transposed element container matrix. If a shape of the element container matrix is not rectangular, this method returns non-transposed one.


The documentation for this class was generated from the following files:
 All Classes Functions Variables Friends