JOSCPROB::JOscillogramAxis Struct Reference

Auxiliary class for defining an oscillogram axis. More...

#include <JOscillogram.hh>

Inheritance diagram for JOSCPROB::JOscillogramAxis:

Public Types
typedef JGrid< double >	JGrid_t
typedef JAbstractCollection < JAbscissa_t >::abscissa_type	abscissa_type

Public Member Functions
	JOscillogramAxis (const int type, const JGrid_t binning)
	Constructor. More...
	JOscillogramAxis (const int type, const int N, const double min, const double max)
	Constructor. More...
virtual int	getSize () const override
	Get number of elements. More...
virtual abscissa_type	getX (int index) const override
	Get abscissa value. More...
virtual abscissa_type	getXmin () const override
	Get minimal abscissa value. More...
virtual abscissa_type	getXmax () const override
	Get maximal abscissa value. More...
int	getIndex (typename JClass< abscissa_type >::argument_type x) const
	Get index of given abscissa value. More...
template<class JElement_t , class JDistance_t >
const JGrid &	operator() (JCollection< JElement_t, JDistance_t > &collection) const
	Configure collection. More...
bool	is_equal (const JAbstractCollection &collection) const
	Test whether abstract collections are equal. More...

Public Attributes
int	type
	axis type More...

Protected Attributes
int	size
abscissa_type	xmin
abscissa_type	xmax

Detailed Description

Auxiliary class for defining an oscillogram axis.

Definition at line 37 of file JOscillogram.hh.

Member Typedef Documentation

typedef JGrid<double> JOSCPROB::JOscillogramAxis::JGrid_t

Definition at line 40 of file JOscillogram.hh.

template<class JAbscissa_t>

typedef JAbstractCollection<JAbscissa_t>::abscissa_type JTOOLS::JGrid< JAbscissa_t >::abscissa_type

inherited

Definition at line 41 of file JGrid.hh.

Constructor & Destructor Documentation

JOSCPROB::JOscillogramAxis::JOscillogramAxis ( const int  type, const JGrid_t  binning  )

inline

Constructor.

Parameters

type	oscillation variable type
binning	oscillation variable binning

Definition at line 49 of file JOscillogram.hh.

                                            :
      JGrid_t(binning),
      type   (type)
    {}

JOSCPROB::JOscillogramAxis::JOscillogramAxis ( const int  type, const int  N, const double  min, const double  max  )

inline

Constructor.

Parameters

type	oscillogram variable type
N	number of bins
min	minimum axis value
max	maximum axis value

Definition at line 64 of file JOscillogram.hh.

                                       :
      JGrid_t(N, min, max),
      type   (type)
    {}

Member Function Documentation

template<class JAbscissa_t>

virtual int JTOOLS::JGrid< JAbscissa_t >::getSize ( ) const

inlineoverridevirtualinherited

Get number of elements.

Returns

number of elements

Implements JTOOLS::JAbstractCollection< JAbscissa_t >.

Definition at line 75 of file JGrid.hh.

    { 
      return size;
    }

template<class JAbscissa_t>

virtual abscissa_type JTOOLS::JGrid< JAbscissa_t >::getX ( int  index ) const

inlineoverridevirtualinherited

Get abscissa value.

Parameters

index

index

Returns

abscissa value

Implements JTOOLS::JAbstractCollection< JAbscissa_t >.

Definition at line 87 of file JGrid.hh.

    {
      return (index == 0 ? xmin : xmin + index * ((xmax - xmin) / (size - 1)));
    }

template<class JAbscissa_t>

virtual abscissa_type JTOOLS::JGrid< JAbscissa_t >::getXmin ( ) const

inlineoverridevirtualinherited

Get minimal abscissa value.

Returns

abscissa value

Implements JTOOLS::JAbstractCollection< JAbscissa_t >.

Definition at line 98 of file JGrid.hh.

    {
      return xmin;
    }

template<class JAbscissa_t>

virtual abscissa_type JTOOLS::JGrid< JAbscissa_t >::getXmax ( ) const

inlineoverridevirtualinherited

Get maximal abscissa value.

Returns

abscissa value

Implements JTOOLS::JAbstractCollection< JAbscissa_t >.

Definition at line 109 of file JGrid.hh.

    {
      return xmax;
    }    

template<class JAbscissa_t>

int JTOOLS::JGrid< JAbscissa_t >::getIndex ( typename JClass< abscissa_type >::argument_type  x ) const

inlineinherited

Get index of given abscissa value.

Parameters

x	abscissa value

Returns

index

Definition at line 121 of file JGrid.hh.

    {
      return (int) ((size - 1) * (x - xmin) / (xmax - xmin));
    }

template<class JAbscissa_t>

template<class JElement_t , class JDistance_t >

const JGrid& JTOOLS::JGrid< JAbscissa_t >::operator() ( JCollection< JElement_t, JDistance_t > &  collection ) const

inlineinherited

Configure collection.

Parameters

collection

collection

Returns

this grid

Definition at line 134 of file JGrid.hh.

    {
      collection.configure(*this);

      return *this;
    }

template<class JAbscissa_t>

bool JTOOLS::JAbstractCollection< JAbscissa_t >::is_equal ( const JAbstractCollection< JAbscissa_t > &  collection ) const

inlineinherited

Test whether abstract collections are equal.

Parameters

collection

abstract collection

Returns

true if collections are equals; else false

Definition at line 72 of file JAbstractCollection.hh.

    {
      if (this->getSize() == collection.getSize()) {

        for (int i = 0; i != this->getSize(); ++i) {

          if (this->getX(i) != collection.getX(i)) {
            return false;
          }
        }

        return true;
      }

      return false;
    }

Member Data Documentation

int JOSCPROB::JOscillogramAxis::type

axis type

Definition at line 73 of file JOscillogram.hh.

template<class JAbscissa_t>

int JTOOLS::JGrid< JAbscissa_t >::size

protectedinherited

Definition at line 194 of file JGrid.hh.

template<class JAbscissa_t>

abscissa_type JTOOLS::JGrid< JAbscissa_t >::xmin

protectedinherited

Definition at line 195 of file JGrid.hh.

template<class JAbscissa_t>

abscissa_type JTOOLS::JGrid< JAbscissa_t >::xmax

protectedinherited

Definition at line 196 of file JGrid.hh.

---

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

• JOscillogram.hh