ODIN
Public Member Functions | List of all members

#include <ldrarrays.h>

Inheritance diagram for LDRtriple:
Inheritance graph
[legend]

Public Member Functions

 LDRtriple ()
 
 LDRtriple (float xpos, float ypos, float zpos, const STD_string &name="")
 
 LDRtriple (const LDRtriple &pos)
 
LDRtripleoperator= (const LDRtriple &pos)
 
STD_string get_typeInfo (bool parx_equivtype=false) const
 
LDRbasecreate_copy () const
 
- Public Member Functions inherited from LDRarray< farray, LDRfloat >
 LDRarray ()
 
 LDRarray (const farray &a, const STD_string &name="")
 
 LDRarray (const LDRarray< farray, LDRfloat > &ja)
 
LDRarray< farray, LDRfloat > & operator= (const farray &a)
 
LDRarray< farray, LDRfloat > & operator= (const LDRfloat &jv)
 
LDRarray< farray, LDRfloat > & operator= (const LDRarray< farray, LDRfloat > &ja)
 
- Public Member Functions inherited from tjarray< fvector, float >
 tjarray ()
 
 tjarray (unsigned long n1)
 
 tjarray (const tjarray< fvector, float > &ta)
 
 tjarray (const fvector &sv)
 
 tjarray (const ndim &nn)
 
tjarray< fvector, float > & operator= (const tjarray< fvector, float > &ta)
 
tjarray< fvector, float > & operator= (const float &value)
 
fvectorresize (unsigned int newsize)
 
tjarray< fvector, float > & redim (const ndim &nn)
 
tjarray< fvector, float > & redim (unsigned long n1)
 
tjarray< fvector, float > & autosize ()
 
const ndimget_extent () const
 
float & operator() (const ndim &ii)
 
const float & operator() (const ndim &ii) const
 
float & operator() (unsigned long n1)
 
const float & operator() (unsigned long n1) const
 
unsigned long dim () const
 
unsigned long size (unsigned long i) const
 
unsigned long total () const
 
unsigned long length () const
 
unsigned int elementsize () const
 
tjarray< fvector, float > & assignValues (const tjarray< fvector, float > &ta)
 
tjarray< fvector, float > & copy (const tjarray< fvector, float > &ta)
 
ndim create_index (unsigned long index) const
 
- Public Member Functions inherited from tjvector< float >
 tjvector (unsigned int n=0)
 
 tjvector (const float *array, unsigned int n)
 
 tjvector (const STD_vector< float > &v)
 
 tjvector (const tjvector< float > &tv)
 
virtual ~tjvector ()
 
tjvector< float > & operator= (const float &value)
 
tjvector< float > & operator= (const STD_vector< float > &vec)
 
tjvector< float > & operator= (const tjvector< float > &tv)
 
tjvector< float > operator+ (const STD_vector< float > &w) const
 
tjvector< float > operator+ (const float &s) const
 
tjvector< float > operator- (const STD_vector< float > &w) const
 
tjvector< float > operator- () const
 
tjvector< float > operator- (const float &s) const
 
tjvector< float > operator* (const STD_vector< float > &w) const
 
tjvector< float > operator* (const float &s) const
 
tjvector< float > operator/ (const STD_vector< float > &w) const
 
tjvector< float > operator/ (const float &s) const
 
tjvector< float > & operator+= (const STD_vector< float > &v)
 
tjvector< float > & operator+= (const float &s)
 
tjvector< float > & operator-= (const STD_vector< float > &v)
 
tjvector< float > & operator-= (const float &s)
 
tjvector< float > & operator*= (const STD_vector< float > &v)
 
tjvector< float > & operator*= (const float &s)
 
tjvector< float > & operator/= (const STD_vector< float > &v)
 
tjvector< float > & operator/= (const float &s)
 
unsigned int length () const
 
unsigned int fill_linear (const float &min, const float &max)
 
float sum () const
 
tjvector< float > range (unsigned int startindex, unsigned int endindex) const
 
float maxvalue () const
 
float minvalue () const
 
float maxabs () const
 
const float * c_array () const
 
tjvectorset_c_array (const unsigned char *array, unsigned int n)
 
float normalize ()
 
tjvectorinterpolate (unsigned int newsize, float subpixel_shift=0.0)
 
int load (const STD_string &fname)
 
int write (const STD_string &fname, fopenMode mode=overwriteMode, LONGEST_INT nelements=-1) const
 
STD_string printbody () const
 
- Public Member Functions inherited from LDRbase
virtual STD_string print (const LDRserBase &serializer=LDRserJDX()) const
 
virtual bool parse (STD_string &parstring, const LDRserBase &serializer=LDRserJDX())
 
virtual double get_minval () const
 
virtual double get_maxval () const
 
bool has_minmax () const
 
const STD_string & get_description () const
 
LDRbaseset_description (const STD_string &descr)
 
virtual svector get_alternatives () const
 
const STD_string & get_unit () const
 
LDRbaseset_unit (const STD_string &un)
 
virtual parameterMode get_parmode () const
 
virtual LDRbaseset_parmode (parameterMode parameter_mode)
 
virtual fileMode get_filemode () const
 
virtual LDRbaseset_filemode (fileMode file_mode)
 
JcampDxProps get_jdx_props () const
 
LDRbaseset_jdx_props (const JcampDxProps &jp)
 
- Public Member Functions inherited from Labeled
 Labeled (const STD_string &label="unnamed")
 
Labeledset_label (const STD_string &label)
 
const STD_string & get_label () const
 
Labeledoperator= (const Labeled &l)
 

Detailed Description

A Labeled Data Record (LDR) vector of 3 float values which is used to store spatial positions, FOVs, etc.

Definition at line 155 of file ldrarrays.h.

Constructor & Destructor Documentation

◆ LDRtriple() [1/3]

LDRtriple::LDRtriple ( )
inline

Default constructor

Definition at line 162 of file ldrarrays.h.

◆ LDRtriple() [2/3]

LDRtriple::LDRtriple ( float  xpos,
float  ypos,
float  zpos,
const STD_string &  name = "" 
)

Constructor with the following arguments:

  • xpos: Spatial position in the first dimension
  • ypos: Spatial position in the second dimension
  • zpos: Spatial position in the third dimension
  • name: The label of the parameter

◆ LDRtriple() [3/3]

LDRtriple::LDRtriple ( const LDRtriple pos)
inline

Copy constructor

Definition at line 176 of file ldrarrays.h.

Member Function Documentation

◆ create_copy()

LDRbase* LDRtriple::create_copy ( ) const
inlinevirtual

Returns a deep copy of the parameter

Implements LDRbase.

Definition at line 188 of file ldrarrays.h.

◆ get_typeInfo()

STD_string LDRtriple::get_typeInfo ( bool  parx_equivtype = false) const
inlinevirtual

Returns a string describing the type of the parameter. If 'parx_equivtype' is 'true', returns the equivalent PARX parameter type

Implements LDRbase.

Definition at line 187 of file ldrarrays.h.

◆ operator=()

LDRtriple& LDRtriple::operator= ( const LDRtriple pos)
inline

Copy assignment

Definition at line 181 of file ldrarrays.h.


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