pdscalibdata::NDArrIOV1< TDATA, NDIM > Class Template Reference
[pdscalibdata package]

#include <NDArrIOV1.h>

List of all members.

Public Types

typedef TDATA data_t

typedef unsigned shape_t

LOADED = 1

DEFAULT

UNREADABLE

UNDEFINED

enum STATUS { LOADED = 1, DEFAULT, UNREADABLE, UNDEFINED }

Public Member Functions

NDArrIOV1 (const std::string &fname, const unsigned print_bits=0377)

Three constructors provide different default initialization. Each of them create an object which holds the file name and pointer (0 before load) to ndarray. File name can be specified later in the get_ndarray(fname) method, but print_file() and print_ndarray() methods will complain about missing file name until it is specified. Constructor with missing default initialization. Empty ndarray will be returned if constants from file can not be loaded.

NDArrIOV1 (const std::string &fname, const shape_t *shape_def, const TDATA &val_def=TDATA(0), const unsigned print_bits=0377)

Constructor with default ndarray of specified shape filled by a single value.

NDArrIOV1 (const std::string &fname, const ndarray< const TDATA, NDIM > &nda_def, const unsigned print_bits=0377)

Constructor with externally defined default ndarray.

~NDArrIOV1 ()

Destructor.

unsigned int ndim () const

Returns number of dimensions of ndarray.

void print ()

void print_file ()

Prints input file line-by-line.

void print_ndarray ()

Loads (if necessary) ndarray from file and print it.

ndarray< TDATA, NDIM > & get_ndarray (const std::string &fname=std::string())

Loads (if necessary) ndarray from file and returns it.

std::string str_status ()

Returns string with status of calibration constants.

STATUS status ()

Returns enumerated status of calibration constants.

std::string str_ndarray_info ()

Returns string with info about ndarray.

std::string str_shape ()

Returns string of shape.

Static Public Member Functions

static void save_ndarray (const ndarray< const TDATA, NDIM > &nda, const std::string &fname, const std::vector< std::string > &vcoms=std::vector< std::string >(), const unsigned &print_bits=0377)

Static method to save ndarray in file with internal metadata and external comments.

Detailed Description

template<typename TDATA, unsigned NDIM>
class pdscalibdata::NDArrIOV1< TDATA, NDIM >

This software was developed for the LCLS project. If you use all or part of it, please give an appropriate acknowledgment.

See also:

Version:

Id: NDArrIOV1.h 12297 2016-07-20 00:10:06Z dubrovin@SLAC.STANFORD.EDU

Author:: Mikhail Dubrovin

Interface

Expected format of the data file with metadata

  # line of comment always begins with # 
  # Mandatory fields to define the ndarray<TYPE,NDIM> and its shape as unsigned shape[NDIM] = {DIM:1,DIM:2,DIM:3}
  # TYPE        float
  # NDIM        3
  # DIM:1       3
  # DIM:2       4
  # DIM:3       8
 
  21757   21769   33464   10769   68489   68561   77637   54810 
  ... other data lines
  21757   21773   33430   10628   68349   68345   77454   54729

Includes and typedefs

  #include "pdscalibdata/NDArrIOV1.h"
  typedef pdscalibdata::NDArrIOV1<float,3> NDAIO;

Instatiation
Constractor 0:
Uses file name as input parameter w/o default initialization:

  std::string fname("path/pedestals/0-end.data"); // mandatory parameter
  unsigned print_bits(0377);                      // optional parameter 

  ARRIO* arrio = new ARRIO(fname, print_bits);

Constractor 1:
Uses file name, array shape, and single value for default initialization:

  std::string fname("path/pedestals/0-end.data"); // mandatory parameter
  unsigned shape[] = {2,3,4};                     // mandatory parameter
  TYPE   val_def = 123;                           // optional parameter
  unsigned print_bits(0377);                      // optional parameter 

  ARRIO* arrio = new ARRIO(fname, shape, data_def, print_bits);

shape is used for
1) cross-check of metadata shape from file,
2) creation of ndarray<TYPE,NDIM> with default parameters if file is missing.

Constractor 2:
Uses file name and default ndarray:

  CalibPars::common_mode_t data_def[] = {1, 50, 10, Size};
  ndarray<CalibPars::common_mode_t,1> nda = make_ndarray(&data_def[0], 4);
  ARRIO* arrio = new ARRIO(fname, nda, print_bits);

Access methods

  const ndarray<const float,3>& nda = arrio -> get_ndarray(); // returns ndarray 
  // or
  const ndarray<const float,3>& nda = arrio -> get_ndarray(fname); // returns ndarray 
  std::string& str_status = arrio -> status(); // returns status comment

Print methods
File name needs to be provided either in constructor or in the get_ndarray(fname) method.

  arrio -> print();         // prints recognized templated parameters
  arrio -> print_file();    // prints input file line-by-line 
  arrio -> print_ndarray(); // prints ndarray

Save ndarray in file

  NDAIO::save_ndarray(nda, fname);

or save ndarray in file with additional comments

  std::vector<std::string> comments;
  comments.push_back("TITLE      File to load ndarray of calibration parameters");
  comments.push_back("EXPERIMENT amo12345");
  comments.push_back("DETECTOR   Camp.0:pnCCD.1");
  comments.push_back("CALIB_TYPE pedestals");

  unsigned print_bits=1;
  NDAIO::save_ndarray(nda, fname, comments, print_bits);

where each record in the vector is added to the file header as a commented string. The last command saves the file with content

  # TITLE      File to load ndarray of calibration parameters
  # 
  # EXPERIMENT amo12345
  # DETECTOR   Camp.0:pnCCD.1
  # CALIB_TYPE pedestals
  
  # DATE_TIME  2014-05-06 15:24:10
  # AUTHOR     <user-login-name>
  
  # Metadata for ndarray<float,3>
  # TYPE     float
  # NDIM     3
  # DIM:0    3
  # DIM:1    4
  # DIM:2    8
  
       21757      21769      33464      10769      68489      68561      77637      54810 
       ...
         102         40        272        270        194        246         60        118

Definition at line 179 of file NDArrIOV1.h.

Member Typedef Documentation

template<typename TDATA, unsigned NDIM>

typedef TDATA pdscalibdata::NDArrIOV1< TDATA, NDIM >::data_t

Definition at line 185 of file NDArrIOV1.h.

template<typename TDATA, unsigned NDIM>

typedef unsigned pdscalibdata::NDArrIOV1< TDATA, NDIM >::shape_t

Definition at line 186 of file NDArrIOV1.h.

Member Enumeration Documentation

template<typename TDATA, unsigned NDIM>

enum pdscalibdata::NDArrIOV1::STATUS

Enumerator:

LOADED
DEFAULT
UNREADABLE
UNDEFINED

Definition at line 188 of file NDArrIOV1.h.

Constructor & Destructor Documentation

template<typename TDATA, unsigned NDIM>

pdscalibdata::NDArrIOV1< TDATA, NDIM >::NDArrIOV1	(	const std::string &	fname,
		const unsigned	print_bits = `0377`
	)

Three constructors provide different default initialization. Each of them create an object which holds the file name and pointer (0 before load) to ndarray. File name can be specified later in the get_ndarray(fname) method, but print_file() and print_ndarray() methods will complain about missing file name until it is specified. Constructor with missing default initialization. Empty ndarray will be returned if constants from file can not be loaded.

Parameters:

`[in]`	fname	- std::string file name
`[in]`	print_bits	- unsigned bit-word to control verbosity

Definition at line 35 of file NDArrIOV1.cpp.

template<typename TDATA, unsigned NDIM>

pdscalibdata::NDArrIOV1< TDATA, NDIM >::NDArrIOV1	(	const std::string &	fname,
		const shape_t *	shape_def,
		const TDATA &	val_def = `TDATA(0)`,
		const unsigned	print_bits = `0377`
	)

Constructor with default ndarray of specified shape filled by a single value.

Parameters:

`[in]`	fname	- std::string file name
`[in]`	shape_def	- default shape of the ndarray (is used for shape crosscheck at readout and in case of missing file or metadata)
`[in]`	val_def	- value to fill all data elements by default(in case of missing file or metadata)
`[in]`	print_bits	- unsigned bit-word to control verbosity

Definition at line 51 of file NDArrIOV1.cpp.

template<typename TDATA, unsigned NDIM>

pdscalibdata::NDArrIOV1< TDATA, NDIM >::NDArrIOV1	(	const std::string &	fname,
		const ndarray< const TDATA, NDIM > &	nda_def,
		const unsigned	print_bits = `0377`
	)

Constructor with externally defined default ndarray.

Parameters:

`[in]`	fname	- std::string file name
`[in]`	nda_def	- default ndarray, which will be returned if file is missing
`[in]`	print_bits	- unsigned bit-word to control verbosity

Definition at line 72 of file NDArrIOV1.cpp.

References ndarray< ElemType, NDim >::shape(), and ndarray< ElemType, NDim >::size().

template<typename TDATA, unsigned NDIM>

pdscalibdata::NDArrIOV1< TDATA, NDIM >::~NDArrIOV1 ( )

Destructor.

Definition at line 91 of file NDArrIOV1.cpp.

References src::psana_doc_info::info, and MsgLog.

Member Function Documentation

template<typename TDATA, unsigned NDIM>

ndarray< TDATA, NDIM > & pdscalibdata::NDArrIOV1< TDATA, NDIM >::get_ndarray ( const std::string & fname = std::string() )

Loads (if necessary) ndarray from file and returns it.

Parameters:

[in] fname std::string file name

Definition at line 324 of file NDArrIOV1.cpp.

References MsgLog.

template<typename TDATA, unsigned NDIM>

unsigned int pdscalibdata::NDArrIOV1< TDATA, NDIM >::ndim ( ) const [inline]

Returns number of dimensions of ndarray.

Definition at line 232 of file NDArrIOV1.h.

Referenced by pdscalibdata::NDArrIOV1< TDATA, NDIM >::print(), pdscalibdata::NDArrIOV1< TDATA, NDIM >::print_ndarray(), pdscalibdata::NDArrIOV1< TDATA, NDIM >::save_ndarray(), pdscalibdata::NDArrIOV1< TDATA, NDIM >::str_ndarray_info(), and pdscalibdata::NDArrIOV1< TDATA, NDIM >::str_shape().

template<typename TDATA, unsigned NDIM>

void pdscalibdata::NDArrIOV1< TDATA, NDIM >::print ( )

Access methods prints recognized templated parameters.

Definition at line 345 of file NDArrIOV1.cpp.

References src::psana_doc_info::info, MsgLog, and pdscalibdata::NDArrIOV1< TDATA, NDIM >::ndim().

Referenced by main().

template<typename TDATA, unsigned NDIM>

void pdscalibdata::NDArrIOV1< TDATA, NDIM >::print_file ( )

Prints input file line-by-line.

Definition at line 361 of file NDArrIOV1.cpp.

References src::psana_doc_info::info, MsgLog, and PsanaModuleDetectorXface::warning().

Referenced by main().

template<typename TDATA, unsigned NDIM>

void pdscalibdata::NDArrIOV1< TDATA, NDIM >::print_ndarray ( )

Loads (if necessary) ndarray from file and print it.

Definition at line 388 of file NDArrIOV1.cpp.

References src::psana_doc_info::info, MsgLog, pdscalibdata::NDArrIOV1< TDATA, NDIM >::ndim(), and ndarray< ElemType, NDim >::size().

Referenced by main().

template<typename TDATA, unsigned NDIM>

void pdscalibdata::NDArrIOV1< TDATA, NDIM >::save_ndarray	(	const ndarray< const TDATA, NDIM > &	nda,
		const std::string &	fname,
		const std::vector< std::string > &	vcoms = `std::vector< std::string >()`,
		const unsigned &	print_bits = `0377`
	)			`[static]`

Static method to save ndarray in file with internal metadata and external comments.

Parameters:

`[in]`	nda	ndarray to save in file
`[in]`	fname	std::string file name to save ndarray
`[in]`	vcoms	std::vector<std::string> vector of strings with comments; one-string comment per vector entry
`[in]`	print_bits	for output control; 0-print nothing, +1-info about saved files

Definition at line 437 of file NDArrIOV1.cpp.

References ex_all_dets::i, src::psana_doc_info::info, MsgLog, ex_andor3d::nda, pdscalibdata::NDArrIOV1< TDATA, NDIM >::ndim(), pdscalibdata::strEnvVar(), and pdscalibdata::strTimeStamp().

Referenced by main(), and ImgAlgos::saveNDArrayInFile().

template<typename TDATA, unsigned NDIM>

STATUS pdscalibdata::NDArrIOV1< TDATA, NDIM >::status ( ) [inline]

Returns enumerated status of calibration constants.

Definition at line 255 of file NDArrIOV1.h.

template<typename TDATA, unsigned NDIM>

std::string pdscalibdata::NDArrIOV1< TDATA, NDIM >::str_ndarray_info ( )

Returns string with info about ndarray.

Definition at line 405 of file NDArrIOV1.cpp.

References ndarray< ElemType, NDim >::data(), ex_all_dets::i, pdscalibdata::NDArrIOV1< TDATA, NDIM >::ndim(), and ndarray< ElemType, NDim >::size().

template<typename TDATA, unsigned NDIM>

std::string pdscalibdata::NDArrIOV1< TDATA, NDIM >::str_shape ( )

Returns string of shape.

Definition at line 425 of file NDArrIOV1.cpp.

References ex_all_dets::i, and pdscalibdata::NDArrIOV1< TDATA, NDIM >::ndim().

template<typename TDATA, unsigned NDIM>

std::string pdscalibdata::NDArrIOV1< TDATA, NDIM >::str_status ( )

Returns string with status of calibration constants.

Definition at line 159 of file NDArrIOV1.cpp.

The documentation for this class was generated from the following files:

pdscalibdata/include/NDArrIOV1.h
pdscalibdata/src/NDArrIOV1.cpp

Generated on 19 Dec 2016 for PSDMSoftware by

1.4.7


Public Types
typedef TDATA	data_t
typedef unsigned	shape_t
	LOADED = 1
	DEFAULT
	UNREADABLE
	UNDEFINED
enum	STATUS { LOADED = 1, DEFAULT, UNREADABLE, UNDEFINED }
Public Member Functions
	NDArrIOV1 (const std::string &fname, const unsigned print_bits=0377)
	Three constructors provide different default initialization. Each of them create an object which holds the file name and pointer (0 before load) to ndarray. File name can be specified later in the get_ndarray(fname) method, but print_file() and print_ndarray() methods will complain about missing file name until it is specified. Constructor with missing default initialization. Empty ndarray will be returned if constants from file can not be loaded.
	NDArrIOV1 (const std::string &fname, const shape_t *shape_def, const TDATA &val_def=TDATA(0), const unsigned print_bits=0377)
	Constructor with default ndarray of specified shape filled by a single value.
	NDArrIOV1 (const std::string &fname, const ndarray< const TDATA, NDIM > &nda_def, const unsigned print_bits=0377)
	Constructor with externally defined default ndarray.
	~NDArrIOV1 ()
	Destructor.
unsigned int	ndim () const
	Returns number of dimensions of ndarray.
void	print ()
void	print_file ()
	Prints input file line-by-line.
void	print_ndarray ()
	Loads (if necessary) ndarray from file and print it.
ndarray< TDATA, NDIM > &	get_ndarray (const std::string &fname=std::string())
	Loads (if necessary) ndarray from file and returns it.
std::string	str_status ()
	Returns string with status of calibration constants.
STATUS	status ()
	Returns enumerated status of calibration constants.
std::string	str_ndarray_info ()
	Returns string with info about ndarray.
std::string	str_shape ()
	Returns string of shape.
Static Public Member Functions
static void	save_ndarray (const ndarray< const TDATA, NDIM > &nda, const std::string &fname, const std::vector< std::string > &vcoms=std::vector< std::string >(), const unsigned &print_bits=0377)
	Static method to save ndarray in file with internal metadata and external comments.

pdscalibdata::NDArrIOV1< TDATA, NDIM > Class Template Reference [pdscalibdata package]

Public Types

Public Member Functions

Static Public Member Functions

Detailed Description

template<typename TDATA, unsigned NDIM> class pdscalibdata::NDArrIOV1< TDATA, NDIM >

Member Typedef Documentation

Member Enumeration Documentation

Constructor & Destructor Documentation

Member Function Documentation

pdscalibdata::NDArrIOV1< TDATA, NDIM > Class Template Reference
[pdscalibdata package]

template<typename TDATA, unsigned NDIM>
class pdscalibdata::NDArrIOV1< TDATA, NDIM >