Ordered irregularly strided cell centered axis. The cells are ordered and disjoint, but gaps may be present. More...
#include <Axis.h>
Inheritance diagram for dp3::parmdb::OrderedAxis:
Public Member Functions | |
| OrderedAxis () | |
| Default constructor creates one cell from -1e30 till 1e30. More... | |
| OrderedAxis (const std::vector< double > &v1, const std::vector< double > &v2, bool asStartEnd=false) | |
| ~OrderedAxis () override | |
| const std::string & | classType () const override |
Return the type of *this as a string. More... | |
| Axis::ShPtr | clone () const override |
| Clone the object. More... | |
| Axis::ShPtr | compress (size_t factor) const override |
| Compress the axis. More... | |
| Axis::ShPtr | doSubset (size_t start, size_t end) const override |
| void | read (blob::BlobIStream &bis) override |
Read the contents from the blob input stream bis into *this. More... | |
| void | write (blob::BlobOStream &bos) const override |
Write the contents of *this into the blob output stream bos. More... | |
 Public Member Functions inherited from dp3::parmdb::Axis | |
| Axis () | |
| The constructor sets the unique id. More... | |
| ~Axis () override | |
| bool | checkIntervals (const Axis &that) const |
| Check if the corresponding intervals in this and that axis are the same. More... | |
| Axis::ShPtr | combine (const Axis &that, int &s1, int &e1, int &s2, int &e2) const |
| std::pair< size_t, bool > | find (double x, bool biasRight=true, size_t start=0) const |
| unsigned int | getId () const |
| Get the unique axis id. More... | |
| bool | isRegular () const |
| Is the axis regular? More... | |
| size_t | locate (double x, bool biasRight=true, size_t start=0) const |
| Get the cellnr as above, but throw an exception if not found. More... | |
| std::pair< double, double > | range () const |
| Get the total range of the axis. More... | |
| size_t | size () const |
| Get nr of cells. More... | |
| Axis::ShPtr | subset (size_t start, size_t end) const |
| Make a subset of the axis for the given start/end index. More... | |
| bool | operator== (const Axis &that) const |
| bool | operator!= (const Axis &that) const |
| double | center (size_t n) const |
| double | width (size_t n) const |
| double | upper (size_t n) const |
| double | lower (size_t n) const |
| const std::vector< double > & | centers () const |
| const std::vector< double > & | widths () const |
| const std::vector< double > & | uppers () const |
| const std::vector< double > & | lowers () const |
| double | start () const |
| double | end () const |
| Axis::ShPtr | subset (double start, double end, size_t &index) const |
| Axis::ShPtr | subset (double start, double end) const |
| Public Member Functions inherited from dp3::blob::BlobStreamable | |
| virtual | ~BlobStreamable () |
| Destructor. More... | |
| void | serialize (BlobOStream &bos) const |
Additional Inherited Members | |
| Public Types inherited from dp3::parmdb::Axis | |
| typedef std::shared_ptr< Axis > | ShPtr |
| Define a shared_ptr for this class. More... | |
| Static Public Member Functions inherited from dp3::parmdb::Axis | |
| static Axis::ShPtr | makeAxis (const std::vector< double > &low, const std::vector< double > &high) |
| Static Public Member Functions inherited from dp3::blob::BlobStreamable | |
| static BlobStreamable * | deserialize (BlobIStream &bis) |
| Protected Member Functions inherited from dp3::parmdb::Axis | |
| void | setup (const std::vector< double > &v1, const std::vector< double > &v2, bool asStartEnd) |
| Set up the object for an irregular axis. More... | |
| void | setup (double start, double width, unsigned int count) |
| Set up the object for a regular axis. More... | |
| Protected Attributes inherited from dp3::parmdb::Axis | |
| std::vector< double > | itsCenter |
| unsigned int | itsId |
| bool | itsIsRegular |
| std::vector< double > | itsLower |
| std::vector< double > | itsUpper |
| std::vector< double > | itsWidth |
| Static Protected Attributes inherited from dp3::parmdb::Axis | |
| static unsigned int | theirId |
| Unique seqnr of an Axis object. Used in class AxisMapping. More... | |
Detailed Description
Ordered irregularly strided cell centered axis. The cells are ordered and disjoint, but gaps may be present.
- Todo:
- Implementation needs carefull inspection if gaps are to be allowed.
Constructor & Destructor Documentation
◆ OrderedAxis() [1/2]
| dp3::parmdb::OrderedAxis::OrderedAxis | ( | ) |
Default constructor creates one cell from -1e30 till 1e30.
◆ OrderedAxis() [2/2]
| dp3::parmdb::OrderedAxis::OrderedAxis | ( | const std::vector< double > & | v1, |
| const std::vector< double > & | v2, | ||
| bool | asStartEnd = false |
||
| ) |
Specify the intervals defined by v1/v2 as center/width or start/end. The vectors must have equal sizes. The intervals must be in ascending order and they have to be disjoint. However, they do not need to be consecutive.
◆ ~OrderedAxis()
|
override |
Member Function Documentation
◆ classType()
|
overridevirtual |
Return the type of *this as a string.
Implements dp3::parmdb::Axis.
◆ clone()
|
overridevirtual |
Clone the object.
Implements dp3::parmdb::Axis.
◆ compress()
|
overridevirtual |
Compress the axis.
Implements dp3::parmdb::Axis.
◆ doSubset()
|
overridevirtual |
Implements dp3::parmdb::Axis.
◆ read()
|
overridevirtual |
Read the contents from the blob input stream bis into *this.
Implements dp3::parmdb::Axis.
◆ write()
|
overridevirtual |
Write the contents of *this into the blob output stream bos.
Implements dp3::parmdb::Axis.
The documentation for this class was generated from the following file:
