A FrameSet whose frames can be referenced by domain name. More...
#include <FrameDict.h>
Public Types | |
| using | ObjectPtr = std::unique_ptr<AstObject, Deleter> |
| unique pointer holding an AST raw pointer | |
Public Member Functions | |
| FrameDict (Frame const &frame, std::string const &options="") | |
| Construct a FrameDict from a single Frame. | |
| FrameDict (Frame const &baseFrame, Mapping const &mapping, Frame const ¤tFrame, std::string const &options="") | |
| Construct a FrameDict from two frames and a mapping that connects them. | |
| FrameDict (FrameSet const &frameSet) | |
| Construct a FrameDict from a FrameSet. | |
| virtual | ~FrameDict () |
| FrameDict (FrameDict const &)=default | |
| Copy constructor: make a deep copy. | |
| FrameDict (FrameDict &&)=default | |
| FrameDict & | operator= (FrameDict const &)=delete |
| FrameDict & | operator= (FrameDict &&)=default |
| std::shared_ptr< FrameDict > | copy () const |
| Return a deep copy of this object. | |
| void | addFrame (int iframe, Mapping const &map, Frame const &frame) override |
| Add a new Frame and an associated Mapping to this FrameSet so as to define a new coordinate system, derived from one which already exists within this FrameSet. | |
| void | addFrame (std::string const &domain, Mapping const &map, Frame const &frame) |
| Variant of addFrame(int, ...) where the initial frame is specified by domain. | |
| std::set< std::string > | getAllDomains () const |
| Get the domain names for all contained Frames (excluding frames with empty or defaulted domain names). | |
| std::shared_ptr< Frame > | getFrame (std::string const &domain, bool copy=true) const |
| Variant of getFrame(int, bool) where the frame is specified by domain name. | |
| std::shared_ptr< Mapping > | getMapping (int from, std::string const &to) const |
| Variant of FrameSet::getMapping with the second frame specified by domain. | |
| std::shared_ptr< Mapping > | getMapping (std::string const &from, int to) const |
| Variant of FrameSet::getMapping with the first frame specified by domain. | |
| std::shared_ptr< Mapping > | getMapping (std::string const &from, std::string const &to) const |
| Variant of FrameSet::getMapping with the both frames specified by domain. | |
| int | getIndex (std::string const &domain) const |
| Get the index of a frame specified by domain. | |
| bool | hasDomain (std::string const &domain) const |
| Return True if a frame in this FrameDict has the specified domain. | |
| void | mirrorVariants (std::string const &domain) |
| Variant of mirrorVariants(int) with the frame specified by domain. | |
| void | remapFrame (std::string const &domain, Mapping &map) |
| Variant of remapFrame(int, Mapping&) with the frame specified by domain. | |
| void | removeFrame (int iframe) override |
| Remove a Frame from a FrameSet. | |
| void | removeFrame (std::string const &domain) |
| Variant of removeFrame(int) with the frame specified by domain. | |
| void | setBase (std::string const &domain) |
| Variant of setBase(int) with the frame specified by domain. | |
| void | setCurrent (std::string const &domain) |
| Variant of setCurrent(int) with the frame specified by domain. | |
| void | setDomain (std::string const &domain) override |
| Set the domain of the current frame (and update the internal dict). | |
| std::shared_ptr< Frame > | getFrame (int iframe, bool copy=true) const |
| Obtain a deep copy of the specified Frame. | |
| std::shared_ptr< Mapping > | getMapping (int from=BASE, int to=CURRENT) const |
| Obtain a Mapping that converts between two Frames in a FrameSet. | |
| void | mirrorVariants (int iframe) |
| Indicates that all access to the Variant attribute of the current Frame should should be forwarded to some other nominated Frame in the FrameSet. | |
| void | remapFrame (int iframe, Mapping &map) |
| Modify the relationship (i.e. | |
| void | setBase (int ind) |
| Set Base: index of base Frame. | |
| void | setCurrent (int ind) |
| Set Current: index of current Frame, starting from 1. | |
| void | addAxes (Frame const &frame) |
| Append the axes from a specified Frame to every existing Frame in this FrameSet. | |
| void | addVariant (Mapping const &map, std::string const &name) |
| Store a new variant Mapping with the current Frame. | |
| std::string | getAllVariants () const |
| Get AllVariants: a list of all variant mappings stored with the current Frame. | |
| int | getBase () const |
| Get Base: index of base Frame. | |
| int | getCurrent () const |
| Get Current: index of current Frame, starting from 1. | |
| int | getNFrame () const |
| Get FrameSet_NFrame "NFrame": number of Frames in the FrameSet, starting from 1. | |
| std::string | getVariant () const |
| Variant: name of variant mapping in use by current Frame | |
| void | renameVariant (std::string const &name) |
| Rename the current Variant of the current Mapping. | |
| double | angle (PointD const &a, PointD const &b, PointD const &c) const |
| Find the angle at point B between the line joining points A and B, and the line joining points C and B. | |
| double | axAngle (PointD const &a, PointD const &b, int axis) const |
| Find the angle, as seen from point A, between the positive direction of a specified axis, and the geodesic curve joining point A to point B. | |
| double | axDistance (int axis, double v1, double v2) const |
| Return a signed value representing the axis increment from axis value v1 to axis value v2. | |
| double | axOffset (int axis, double v1, double dist) const |
| Return an axis value formed by adding a signed axis increment onto a supplied axis value. | |
| std::shared_ptr< FrameSet > | convert (Frame const &to, std::string const &domainlist="") |
| Compute a frameset that describes the conversion between this frame and another frame. | |
| double | distance (PointD const &point1, PointD const &point2) const |
| Find the distance between two points whose Frame coordinates are given. | |
| std::shared_ptr< FrameSet > | findFrame (Frame const &tmplt, std::string const &domainlist="") |
| Find a coordinate system with specified characteristics. | |
| std::string | format (int axis, double value) const |
| Return a string containing the formatted (character) version of a coordinate value for a Frame axis. | |
| bool | getActiveUnit () const |
| Get ActiveUnit: pay attention to units when one Frame is used to match another? | |
| std::string | getAlignSystem () const |
| Get AlignSystem: the coordinate system used by convert and findFrame to align Frames. | |
| double | getBottom (int axis) const |
| Get Bottom for one axis: the lowest axis value to display. | |
| int | getDigits () const |
| Get Digits: the default used if no specific value specified for an axis. | |
| int | getDigits (int axis) const |
| Get Digits for one axis. | |
| bool | getDirection (int axis) const |
| Get Direction for one axis: display axis in conventional direction? | |
| std::string | getDomain () const |
| Get Domain: coordinate system domain. | |
| double | getDut1 () const |
| Get Dut1: difference between the UT1 and UTC timescale (sec) | |
| double | getEpoch () const |
| Get Epoch: Epoch of observation. | |
| std::string | getFormat (int axis) const |
| Get Format for one axis: format specification for axis values. | |
| std::string | getInternalUnit (int axis) const |
| Get InternalUnit(axis) read-only attribute for one axis: physical units for unformated axis values. | |
| std::string | getLabel (int axis) const |
| Get Label(axis) for one axis: axis label. | |
| bool | getMatchEnd () const |
| Get MatchEnd: match trailing axes? | |
| int | getMaxAxes () const |
| Get MaxAxes: the maximum axes a frame found by findFrame may have. | |
| int | getMinAxes () const |
| Get MinAxes: the maximum axes a frame found by findFrame may have. | |
| int | getNAxes () const |
| Get NAxes: the number of axes in the frame (i.e. | |
| std::string | getNormUnit (int axis) const |
| Get NormUnit(axis) read-only attribute for one frame: normalised physical units for formatted axis values. | |
| double | getObsAlt () const |
| Get ObsAlt: Geodetic altitude of observer (m). | |
| std::string | getObsLat () const |
| Get ObsLat: Geodetic latitude of observer. | |
| std::string | getObsLon () const |
| Get ObsLon: Geodetic longitude of observer. | |
| bool | getPermute () const |
| Get Permute: allow axis permutation when used as a template? | |
| bool | getPreserveAxes () const |
| Get PreserveAxes: preserve axes? | |
| std::string | getSymbol (int axis) const |
| Get Symbol(axis) for one axis: axis symbol. | |
| std::string | getSystem () const |
| Get System: coordinate system used to describe positions within the domain. | |
| std::string | getTitle () const |
| Get Title: frame title. | |
| double | getTop (int axis) const |
| Get Top: the highest axis value to display. | |
| std::string | getUnit (int axis) const |
| Get Unit(axis) for one axis: physical units for formatted axis values. | |
| std::vector< double > | intersect (std::vector< double > const &a1, std::vector< double > const &a2, std::vector< double > const &b1, std::vector< double > const &b2) const |
| Find the point of intersection between two geodesic curves. | |
| std::vector< int > | matchAxes (Frame const &other) const |
| Look for corresponding axes between this frame and another. | |
| CmpFrame | under (Frame const &next) const |
Combine this frame with another to form a compound frame (CmpFrame), with the axes of this frame followed by the axes of the next frame. | |
| ParallelMap | under (Mapping const &next) const |
| Return a parallel compound mapping containing shallow copies of the original. | |
| PointD | norm (PointD value) const |
| Normalise a set of Frame coordinate values which might be unsuitable for display (e.g. | |
| PointD | offset (PointD point1, PointD point2, double offset) const |
| Find the point which is offset a specified distance along the geodesic curve between two other points. | |
| DirectionPoint | offset2 (PointD const &point1, double angle, double offset) const |
| Find the point which is offset a specified distance along the geodesic curve at a given angle from a specified starting point. | |
| void | permAxes (std::vector< int > perm) |
| Permute the order in which a Frame's axes occur. | |
| FrameMapping | pickAxes (std::vector< int > const &axes) const |
| Create a new Frame whose axes are copied from an existing Frame along with other Frame attributes, such as its Title. | |
| ResolvedPoint | resolve (std::vector< double > const &point1, std::vector< double > const &point2, std::vector< double > const &point3) const |
| Resolve a vector into two orthogonal components. | |
| void | setAlignSystem (std::string const &system) |
| Set AlignSystem: the coordinate system used by convert and findFrame to align Frames. | |
| void | setBottom (int axis, double bottom) |
| Set Bottom: the lowest axis value to display. | |
| void | setDigits (int digits) |
| Set Digits for all axes: number of digits of precision. | |
| void | setDigits (int axis, int digits) |
| Set Digits for one axis: number of digits of precision. | |
| void | setDirection (bool direction, int axis) |
| Set Direction for one axis: display axis in conventional direction? | |
| void | setDut1 (double dut1) |
| Set Dut1: difference between the UT1 and UTC timescale (sec) | |
| void | setEpoch (double epoch) |
| Set Epoch: Epoch of observation as a double (years) | |
| void | setEpoch (std::string const &epoch) |
| Set Epoch: Epoch of observation as a string. | |
| void | setFormat (int axis, std::string const &format) |
| Set Format for one axis: format specification for axis values. | |
| void | setLabel (int axis, std::string const &label) |
| Set Label(axis) for one axis: axis label. | |
| void | setMatchEnd (bool match) |
| Set MatchEnd: match trailing axes? | |
| void | setMaxAxes (int maxAxes) |
| Get MaxAxes: the maximum number of axes a frame found by findFrame may have. | |
| void | setMinAxes (int minAxes) |
| Get MinAxes: the minimum number of axes a frame found by findFrame may have. | |
| void | setObsAlt (double alt) |
| Set ObsAlt: Geodetic altitude of observer (m). | |
| void | setObsLat (std::string const &lat) |
| Set ObsLat: frame title. | |
| void | setObsLon (std::string const &lon) |
| Set ObsLon: Geodetic longitude of observer. | |
| void | setActiveUnit (bool enable) |
| Set ActiveUnit: pay attention to units when one Frame is used to match another? | |
| void | setPermute (bool permute) |
| Set Permute: allow axis permutation when used as a template? | |
| void | setPreserveAxes (bool preserve) |
| Set PreserveAxes: preserve axes? | |
| void | setSymbol (int axis, std::string const &symbol) |
| Set Symbol(axis) for one axis: axis symbol. | |
| void | setSystem (std::string const &system) |
| Set System: coordinate system used to describe positions within the domain. | |
| void | setTitle (std::string const &title) |
| Set Title: frame title. | |
| void | setTop (int axis, double top) |
| Set Top for one axis: the highest axis value to display. | |
| void | setUnit (int axis, std::string const &unit) |
| Set Unit(axis) for one axis: physical units for formatted axis values. | |
| NReadValue | unformat (int axis, std::string const &str) const |
| Read a formatted coordinate value (given as a character string) for a Frame axis and return the number of characters read and the value. | |
| int | getNIn () const |
| Get NIn: the number of input axes. | |
| int | getNOut () const |
| Get NOut: the number of output axes. | |
| bool | getIsSimple () const |
| Get IsSimple: has the mapping been simplified? | |
| bool | isInverted () const |
| Is this an inverted mapping? | |
| bool | getIsLinear () const |
| Get IsLinear: is the Mapping linear? | |
| bool | getReport () const |
| Get Report: report transformed coordinates to stdout? | |
| bool | hasForward () const |
| Is the forward transform available? | |
| bool | hasInverse () const |
| Is the inverse transform available? | |
| std::shared_ptr< Mapping > | inverted () const |
| Get an inverse mapping. | |
| Array2D | linearApprox (PointD const &lbnd, PointD const &ubnd, double tol) const |
| Compute a linear approximation to the forward transformation. | |
| SeriesMap | then (Mapping const &next) const |
| Return a series compound mapping this(first(input)) containing shallow copies of the original. | |
| double | rate (PointD const &at, int ax1, int ax2) const |
| Evaluate the rate of change of the Mapping with respect to a specified input, at a specified position. | |
| void | setReport (bool report) |
| Set Report: report transformed coordinates to stdout? | |
| std::shared_ptr< Mapping > | simplified () const |
| Return a simplied version of the mapping (which may be a compound Mapping such as a CmpMap). | |
| void | applyForward (ConstArray2D const &from, Array2D const &to) const |
| Perform a forward transformation on 2-D array, putting the results into a pre-allocated 2-D array. | |
| Array2D | applyForward (ConstArray2D const &from) const |
| Perform a forward transformation on a 2-D array, returning the results as a new array. | |
| std::vector< double > | applyForward (std::vector< double > const &from) const |
| Perform a forward transformation on a vector, returning the results as a new vector. | |
| void | applyInverse (ConstArray2D const &from, Array2D const &to) const |
| Perform an inverse transformation on a 2-D array, putting the results into a pre-allocated 2-D array. | |
| Array2D | applyInverse (ConstArray2D const &from) const |
| Perform an inverse transformation on a 2-D array, returning the results as a new 2-D array. | |
| std::vector< double > | applyInverse (std::vector< double > const &from) const |
| Perform an inverse transformation on a vector, returning the results as a new vector. | |
| void | tranGridForward (PointI const &lbnd, PointI const &ubnd, double tol, int maxpix, Array2D const &to) const |
| Transform a grid of points in the forward direction. | |
| Array2D | tranGridForward (PointI const &lbnd, PointI const &ubnd, double tol, int maxpix, int nPts) const |
| Transform a grid of points in the inverse direction, returning the results as a new Array2D. | |
| void | tranGridInverse (PointI const &lbnd, PointI const &ubnd, double tol, int maxpix, Array2D const &to) const |
| Transform a grid of points in the inverse direction. | |
| Array2D | tranGridInverse (PointI const &lbnd, PointI const &ubnd, double tol, int maxpix, int nPts) const |
| Transform a grid of points in the inverse direction. | |
| bool | operator== (Object const &rhs) const |
Return True if this and rhs are the equal. | |
| bool | operator!= (Object const &rhs) const |
Return True if this and rhs are not equal. | |
| void | clear (std::string const &attrib) |
| Clear the values of a specified set of attributes for an Object. | |
| bool | hasAttribute (std::string const &attrib) const |
| Does this object have an attribute with the specified name? | |
| std::string | getClassName () const |
| Get Class: the name of the class (e.g. | |
| std::string | getID () const |
| Get ID: object identification string that is not copied. | |
| std::string | getIdent () const |
| Get Ident: object identification string that is copied. | |
| int | getNObject () const |
| Get NObject: number of AST objects in existence of the same type as the underlying AST class. | |
| int | getObjSize () const |
| Get ObjSize: the in-memory size of the AST object in bytes. | |
| int | getRefCount () const |
| Get RefCount: number of active pointers to the underlying AST object. | |
| bool | getUseDefs () const |
| Get UseDefs: allow use of default values for Object attributes? | |
| void | lock (bool wait) |
| Lock this object for exclusive use by the calling thread. | |
| bool | same (Object const &other) const |
| Does this contain the same AST object as another? | |
| void | setID (std::string const &id) |
| Set ID: object identification string that is not copied. | |
| void | setIdent (std::string const &ident) |
| Set Ident: object identification string that is copied. | |
| void | setUseDefs (bool usedefs) |
| Set UseDefs: allow use of default values for Object attributes? | |
| void | show (std::ostream &os, bool showComments=true) const |
| Print a textual description the object to an ostream. | |
| std::string | show (bool showComments=true) const |
| Return a textual description the object as a string. | |
| bool | test (std::string const &attrib) const |
| Has this attribute been explicitly set (and not subsequently cleared)? | |
| void | unlock (bool report=false) |
| Unlock this object previously locked using lock, so that other threads can use this object. | |
| AstObject const * | getRawPtr () const |
| Get the raw AST pointer. | |
| AstObject * | getRawPtr () |
| Get the raw AST pointer. | |
Static Public Member Functions | |
| static std::shared_ptr< Object > | fromString (std::string const &str) |
| Construct an Object from a string, using astFromString. | |
| template<typename Class > | |
| static std::shared_ptr< Class > | fromAstObject (AstObject *rawObj, bool copy) |
| Given a bare AST object pointer return a shared pointer to an ast::Object of the correct type. | |
Static Public Attributes | |
| static int constexpr | BASE = AST__BASE |
| index of base frame | |
| static int constexpr | CURRENT = AST__CURRENT |
| index of current frame | |
| static int constexpr | NOFRAME = AST__NOFRAME |
| an invalid frame index | |
Protected Member Functions | |
| virtual std::shared_ptr< Object > | copyPolymorphic () const override |
| Return a deep copy of this object. | |
| std::shared_ptr< FrameSet > | getFrameSet () const |
| Return a deep copy as a FrameSet. | |
| FrameDict (AstFrameSet *rawptr) | |
| Construct a FrameDict from a raw AST pointer. | |
| template<typename Class > | |
| std::shared_ptr< Class > | decompose (int i, bool copy) const |
| Return a deep copy of one of the two component mappings. | |
| template<typename T , typename AstT > | |
| std::shared_ptr< T > | copyImpl () const |
| Implementation of deep copy. | |
| bool | getB (std::string const &attrib) const |
| Get the value of an attribute as a bool. | |
| std::string const | getC (std::string const &attrib) const |
| Get the value of an attribute as a string. | |
| double | getD (std::string const &attrib) const |
| Get the value of an attribute as a double. | |
| float | getF (std::string const &attrib) const |
| Get the value of an attribute as a float. | |
| int | getI (std::string const &attrib) const |
| Get the value of an attribute as an int. | |
| long int | getL (std::string const &attrib) const |
| Get the value of an attribute as a long int. | |
| void | set (std::string const &setting) |
| Assign a set of attribute values, over-riding any previous values. | |
| void | setB (std::string const &attrib, bool value) |
| Set the value of an attribute as a bool. | |
| void | setC (std::string const &attrib, std::string const &value) |
| Set the value of an attribute as a string. | |
| void | setD (std::string const &attrib, double value) |
| Set the value of an attribute as a double. | |
| void | setF (std::string const &attrib, float value) |
| Set the value of an attribute as a float. | |
| void | setI (std::string const &attrib, int value) |
| Set the value of an attribute as an int. | |
| void | setL (std::string const &attrib, long int value) |
| Set the value of an attribute as a long int. | |
Static Protected Member Functions | |
| template<typename ShimT , typename AstT > | |
| static std::shared_ptr< ShimT > | makeShim (AstObject *p) |
| Functor to make an astshim instance from a raw AST pointer of the corresponding type. | |
Friends | |
| class | Object |
Detailed Description
A FrameSet whose frames can be referenced by domain name.
For every FrameSet method that takes a frame index, the same method in FrameDict may take a (case blind) domain name or a frame index.
This has several useful applications:
- Locate a frame without changing the FrameSet (findFrame is not a const method).
- Locate a frame or mapping in a way that is unaffected by deleting frames (indices change, domain names do not).
All contained Frames with explicitly set, non-empty domains must have unique domains (where the comparison ignores case). Use FrameSet if you want a collection of Frames that may have matching domains.
- Warning
- FrameDict is a convenience wrapper around FrameSet with no corresponding class in AST. As a consequence:
- FrameDict.getClassName returns "FrameSet"
- A FrameDict persisted using a Channel or pickle is unpersisted as a FrameSet
- Note
Attributes
All those of FrameSet.
Definition at line 67 of file FrameDict.h.
Member Typedef Documentation
◆ ObjectPtr
|
inherited |
Constructor & Destructor Documentation
◆ FrameDict() [1/6]
|
inlineexplicit |
Construct a FrameDict from a single Frame.
The frame is deep copied.
- Parameters
-
[in] frame the first Frame to be inserted into the FrameDict. This initially becomes both the base and the current Frame. Further Frames may be added using addFrame [in] options Comma-separated list of attribute assignments.
Definition at line 81 of file FrameDict.h.
◆ FrameDict() [2/6]
|
inlineexplicit |
Construct a FrameDict from two frames and a mapping that connects them.
Both frames and the mapping are deep copied.
- Parameters
-
[in] baseFrame base Frame. [in] mapping mapping connecting baseFrame to currentFrame. [in] currentFrame current Frame. [in] options Comma-separated list of attribute assignments.
- Exceptions
-
std::invalid_argument if both Frames have the same non-empty domain.
Definition at line 97 of file FrameDict.h.
◆ FrameDict() [3/6]
|
inlineexplicit |
Construct a FrameDict from a FrameSet.
The FrameSet is deep-copied
- Exceptions
-
std::invalid_argument if two Frames in the FrameSet have the same non-empty domain.
Definition at line 110 of file FrameDict.h.
◆ ~FrameDict()
|
inlinevirtual |
Definition at line 114 of file FrameDict.h.
◆ FrameDict() [4/6]
|
default |
Copy constructor: make a deep copy.
◆ FrameDict() [5/6]
|
default |
◆ FrameDict() [6/6]
|
explicitprotected |
Construct a FrameDict from a raw AST pointer.
Definition at line 74 of file FrameDict.cc.
Member Function Documentation
◆ addAxes()
|
inlineinherited |
Append the axes from a specified Frame to every existing Frame in this FrameSet.
In detail, each Frame in this FrameSet is replaced by a CmpFrame containing the original Frame and the Frame specified by parameter frame. In addition, each Mapping in the FrameSet is replaced by a CmpMap containing the original Mapping and a UnitMap in parallel. The NIn and NOut attributes of the UnitMap are set equal to the number of axes in the supplied Frame. Each new CmpMap is simplified before being stored in the FrameSet.
Definition at line 160 of file FrameSet.h.
◆ addFrame() [1/2]
|
overridevirtual |
Add a new Frame and an associated Mapping to this FrameSet so as to define a new coordinate system, derived from one which already exists within this FrameSet.
If frame is a Frame then it becomes the current frame and its index is the new number of frames. If frame is a FrameSet then its current frame becomes the new current frame and the indices of all its frames are increased by the number of frames originally in this FrameSet. In both cases the indices of the Frames already in this FrameSet are left unchanged.
- Parameters
-
[in] iframe The index of the Frame within the FrameSet which describes the coordinate system upon which the new one is to be based. This value should lie in the range from 1 to the number of frames already in this FrameSet (as given by getNFrame). A value of FrameSet::BASE or FrameSet::CURRENT may be given to specify the base Frame or the current Frame respectively. A value of AST__ALLFRAMESis not permitted; calladdAllFramesinstead.[in] map A Mapping which describes how to convert coordinates from the old coordinate system (described by the Frame with index iframe) into coordinates in the new system. The Mapping's forward transformation should perform this conversion, and its inverse transformation should convert in the opposite direction.[in] frame A Frame that describes the new coordinate system. Any type of Frame may be supplied (including Regions and FrameSets). This function may also be used to merge two FrameSets by supplying a pointer to a second FrameSet for this parameter (see the Notes section for details).
Notes
- Deep copies of the supplied
mapandframeare stored within the modified FrameSet. So any changes made to the FrameSet after calling this method will have no effect on the supplied Mapping and Frame objects. - This function sets the value of the
Currentattribute for the FrameSet so that the new Frame subsequently becomes the current Frame. - The number of input coordinate values accepted by the supplied
map(its NIn attribute) must match the number of axes in the Frame identified by theiframeparameter. Similarly, the number of output coordinate values generated bymap(its NOut attribute) must match the number of axes inframe. - As a special case, if a pointer to a FrameSet is given for the
frameparameter, this is treated as a request to mergeframeinto this FrameSet. This is done by appending all the new Frames in theframeFrameSet to this FrameSet, while preserving their order and retaining all the inter-relationships (i.e. Mappings) between them. The two sets of Frames are inter-related within the merged FrameSet by using the Mapping supplied. This should convert between the Frame identified by theiframeparameter (in this FrameSet) and thecurrentFrame of theframeFrameSet. This latter Frame becomes the current Frame in this FrameSet.
- Exceptions
-
std::invalid_argument if framehas a non-empty domain and this FrameDict already contains a Frame with that domain
Reimplemented from ast::FrameSet.
Definition at line 32 of file FrameDict.cc.
◆ addFrame() [2/2]
| void ast::FrameDict::addFrame | ( | std::string const & | domain, |
| Mapping const & | map, | ||
| Frame const & | frame ) |
Variant of addFrame(int, ...) where the initial frame is specified by domain.
Definition at line 41 of file FrameDict.cc.
◆ addVariant()
|
inlineinherited |
Store a new variant Mapping with the current Frame.
The newly added variant becomes the current variant (attribute the Variant is set to name).
See the Variant attribute for more details. See also getVariant, renameVariant and mirrorVariants
- Parameters
-
[in] map A Mapping which describes how to convert coordinates from the current frame to the new variant of the current Frame. [in] name The name to associate with the new variant Mapping.
- Exceptions
-
std::runtime_error if:
Definition at line 234 of file FrameSet.h.
◆ angle()
|
inlineinherited |
Find the angle at point B between the line joining points A and B, and the line joining points C and B.
These lines will in fact be geodesic curves appropriate to the Frame in use. For instance, in SkyFrame, they will be great circles.
- Parameters
-
[in] a the coordinates of the first point [in] b the coordinates of the first second [in] c the coordinates of the first third
- Returns
- The angle in radians, from the line AB to the line CB. If the Frame is 2-dimensional, it will be in the range [-pi, pi], and positive rotation is in the same sense as rotation from the positive direction of axis 2 to the positive direction of axis 1. If the Frame has more than 2 axes, a positive value will always be returned in the range (0, pi].
- Exceptions
-
std::invalid_argument if a,borchave the wrong length
Definition at line 201 of file Frame.h.
◆ applyForward() [1/3]
|
inlineinherited |
Perform a forward transformation on a 2-D array, returning the results as a new array.
- Parameters
-
[in] from input coordinates, with dimensions (nPts, nIn)
- Returns
- the results as a new array with dimensions (nPts, nOut)
Definition at line 268 of file Mapping.h.
◆ applyForward() [2/3]
|
inlineinherited |
◆ applyForward() [3/3]
|
inlineinherited |
Perform a forward transformation on a vector, returning the results as a new vector.
- Parameters
-
[in] from input coordinates as a vector, with axes adjacent, e.g. x0, y0, x1, y1...xn, yn
- Returns
- the results as a new vector
Definition at line 280 of file Mapping.h.
◆ applyInverse() [1/3]
|
inlineinherited |
Perform an inverse transformation on a 2-D array, returning the results as a new 2-D array.
- Parameters
-
[in] from output coordinates, with dimensions (nPts, nOut)
- Returns
- the results as a new array with dimensions (nPts, nIn)
◆ applyInverse() [2/3]
|
inlineinherited |
Perform an inverse transformation on a 2-D array, putting the results into a pre-allocated 2-D array.
- Parameters
-
[in] from input coordinates, with dimensions (nPts, nOut) [out] to transformed coordinates, with dimensions (nPts, nIn)
Definition at line 294 of file Mapping.h.
◆ applyInverse() [3/3]
|
inlineinherited |
Perform an inverse transformation on a vector, returning the results as a new vector.
- Parameters
-
[in] from input coordinates as a vector, with axes adjacent, e.g. x0, y0, x1, y1...xn, yn
- Returns
- the results as a new vector
Definition at line 314 of file Mapping.h.
◆ axAngle()
Find the angle, as seen from point A, between the positive direction of a specified axis, and the geodesic curve joining point A to point B.
- Parameters
-
[in] a the coordinates of the first point [in] b the coordinates of the second point [in] axis the index of the axis from which the angle is to be measured, where 1 is the first axis
- Returns
- The angle in radians, from the positive direction of the specified axis, to the line AB. If the Frame is 2-dimensional, it will be in the range [-pi/2, +pi/2], and positive rotation is in the same sense as rotation from the positive direction of axis 2 to the positive direction of axis 1. If the Frame has more than 2 axes, a positive value will always be returned in the range (0, pi]
- Exceptions
-
std::invalid_argument if aorbhave the wrong length
Notes:
- The geodesic curve used by this function is the path of shortest distance between two points, as defined by the
distancemethod.
Definition at line 229 of file Frame.h.
◆ axDistance()
|
inlineinherited |
Return a signed value representing the axis increment from axis value v1 to axis value v2.
For a simple Frame, this is a trivial operation returning the difference between the two axis values. But for other derived classes of Frame (such as a SkyFrame) this is not the case.
- Parameters
-
[in] axis The index of the axis to which the supplied values refer. The first axis has index 1. [in] v1 The first axis value. [in] v2 The second axis value.
- Returns
- The distance from the first to the second axis value.
◆ axOffset()
|
inlineinherited |
Return an axis value formed by adding a signed axis increment onto a supplied axis value.
For a simple Frame, this is a trivial operation returning the sum of the two supplied values. But for other derived classes of Frame (such as a SkyFrame) this is not the case.
- Parameters
-
[in] axis The index of the axis to which the supplied values refer. The first axis has index 1. [in] v1 The original axis value. [in] dist The axis increment to add to the original axis value.
- Returns
- The incremented axis value
◆ clear()
|
inlineinherited |
Clear the values of a specified set of attributes for an Object.
Clearing an attribute cancels any value that has previously been explicitly set for it, so that the standard default attribute value will subsequently be used instead. This also causes the astTest function to return the value zero for the attribute, indicating that no value has been set.
◆ convert()
|
inherited |
Compute a frameset that describes the conversion between this frame and another frame.
If conversion is possible, it returns a shared pointer to a FrameSet which describes the conversion and which may be used (as a Mapping) to transform coordinate values in either direction. Otherwise it returns an empty shared pointer.
The same function may also be used to determine how to convert between two FrameSets (or between a Frame and a FrameSet, or vice versa). This mode is intended for use when (for example) two images have been calibrated by attaching a FrameSet to each. convert might then be used to search for a celestial coordinate system that both images have in common, and the result could then be used to convert between the pixel coordinates of both images – having effectively used their celestial coordinate systems to align them.
When using FrameSets, there may be more than one possible intermediate coordinate system in which to perform the conversion (for instance, two FrameSets might both have celestial coordinates, detector coordinates, pixel coordinates, etc.). A comma-separated list of coordinate system domains may therefore be given which defines a priority order to use when selecting the intermediate coordinate system. The path used for conversion must go via an intermediate coordinate system whose Domain attribute matches one of the domains given. If conversion cannot be achieved using the first domain, the next one is considered, and so on, until success is achieved.
Applicability
-
If the AlignSideBand attribute is non-zero, alignment occurs in the upper sideband expressed within the spectral system and standard of rest given by attributes AlignSystem and
AlignStdOfRest. IfAlignSideBandis zero, the two DSBSpecFrames are aligned as if they were simple SpecFrames (i.e. the SideBand is ignored). -
This function applies to all Frames. Alignment occurs within the coordinate system given by attribute AlignSystem.
-
If either this object or
tois a FrameSet, then this method will attempt to convert from the coordinate system described by the current Frame of the "from" FrameSet to that described by the current Frame of the "to" FrameSet.To achieve this, it will consider all of the Frames within each FrameSet as a possible way of reaching an intermediate coordinate system that can be used for the conversion. There is then the possibility that more than one conversion path may exist and, unless the choice is sufficiently restricted by the "domainlist" string, the sequence in which the Frames are considered can be important. In this case, the search for a conversion path proceeds as follows:
- Each field in the "domainlist" string is considered in turn.
- The Frames within each FrameSet are considered in a specific order: (1) the base Frame is always considered first, (2) after this come all the other Frames in Frame-index order (but omitting the base and current Frames), (3) the current Frame is always considered last. However, if either FrameSet's Invert attribute is set to a non-zero value (so that the FrameSet is inverted), then its Frames are considered in reverse order. (Note that this still means that the base Frame is considered first and the current Frame last, because the Invert value will also cause these Frames to swap places.)
- All source Frames are first considered (in the appropriate order) for conversion to the first destination Frame. If no suitable intermediate coordinate system emerges, they are then considered again for conversion to the second destination Frame (in the appropriate order), and so on.
- Generally, the first suitable intermediate coordinate system found is used. However, the overall Mapping between the source and destination coordinate systems is also examined. Preference is given to cases where both the forward and inverse transformations are defined. If only one transformation is defined, the forward one is preferred.
- If the domain of the intermediate coordinate system matches the current "domainlist" field, the conversion path is accepted. Otherwise, the next "domainlist" field is considered and the process repeated.
If conversion is possible, the Base attributes of the two FrameSets will be modified on exit to identify the Frames used to access the intermediate coordinate system which was finally accepted.
Note that it is possible to force a particular Frame within a FrameSet to be used as the basis for the intermediate coordinate system, if it is suitable, by (a) focussing attention on it by specifying its domain in the "domainlist" string, or (b) making it the base Frame, since this is always considered first.
-
Alignment occurs within the spectral system and standard of rest given by attributes AlignSystem and
AlignStdOfRest. -
Alignment occurs within the time system and time scale given by attributes AlignSystem and
AlignTimeScale.
Examples
auto cvt = a.convert(b)Obtain a FrameSet that converts between the coordinate systems represented by "a" and "b" (assumed to be Frames).
auto cvt = SkyFrame().convert(SkyFrame("Equinox=2005"))Create a FrameSet which describes precession in the default FK5 celestial coordinate system between equinoxes J2000 (also the default) and J2005. The returned "cvt" FrameSet may be used to apply this precession correction to any number of coordinate values given in radians.
Note that the returned FrameSet also contains information about how to format coordinate values. This means that setting its Report attribute to 1 is a simple way to obtain printed output (formatted in sexagesimal notation) to show the coordinate values before and after conversion.
auto cvt = a.convert(b, "sky,detector,")Create a FrameSet that converts between the coordinate systems represented by the current Frames of "a" and "b" (now assumed to be FrameSets), via the intermediate "SKY" coordinate system. This, by default, is the Domain associated with a celestial coordinate system represented by a SkyFrame.
If this fails (for example, because either FrameSet lacks celestial coordinate information), then the user-defined "DETECTOR" coordinate system is used instead. If this also fails, then all other possible ways of achieving conversion are considered before giving up.
The returned "cvt" FrameSet describes the conversion.
The Base attributes of the two FrameSet will be set by `ref convert to indicate which of their Frames was used for the intermediate coordinate system. This means that you can subsequently determine which coordinate system was used by enquiring the Domain attribute of either base Frame.
- Parameters
-
[in,out] to A Frame which represents the "destination" coordinate system. This is the coordinate system into which you wish to convert your coordinates. If a FrameSet is given, its current Frame (as determined by its Current attribute) is taken to describe the destination coordinate system. Note that the Base attribute of this FrameSet may be modified by this function to indicate which intermediate coordinate system was used. [in] domainlist A string containing a comma-separated list of Frame domains. This may be used to define a priority order for the different intermediate coordinate systems that might be used to perform the conversion. The function will first try to obtain a conversion by making use only of an intermediate coordinate system whose Domain attribute matches the first domain in this list. If this fails, the second domain in the list will be used, and so on, until conversion is achieved. A blank domain (e.g. two consecutive commas) indicates that all coordinate systems should be considered, regardless of their domains.
- Returns
- A FrameSet which describes the conversion and contains two Frames, or an empty shared pointer if the conversion is not possible. Frame number 1 (its base Frame) will describe the source coordinate system, corresponding to the "from" parameter. Frame number 2 (its current Frame) will describe the destination coordinate system, corresponding to the "to" parameter. The Mapping which inter-relates these two Frames will perform the required conversion between their respective coordinate systems. Note that a FrameSet may be used both as a Mapping and as a Frame. If the result is used as a Mapping then it provides a means of converting coordinates from the source to the destination coordinate system (or vice versa if its inverse transformation is selected). If it is used as a Frame, its attributes will describe the destination coordinate system.
Notes
- The Mapping represented by the returned FrameSet results in alignment taking place in the coordinate system specified by the AlignSystem attribute of the "to" Frame. See the description of the AlignSystem attribute for further details.
- When aligning (say) two images, which have been calibrated by attaching FrameSets to them, it is usually necessary to convert between the base Frames (representing "native" pixel coordinates) of both FrameSets. This may be achieved by obtaining the inverses of the FrameSets (using inverted).
Definition at line 31 of file Frame.cc.
◆ copy()
|
inline |
Return a deep copy of this object.
Definition at line 123 of file FrameDict.h.
◆ copyImpl()
|
inlineprotectedinherited |
◆ copyPolymorphic()
|
inlineoverrideprotectedvirtual |
Return a deep copy of this object.
This is called by copy.
Each subclass must override this method. The standard implementation is:
for example Frame implements this as:
Reimplemented from ast::FrameSet.
Definition at line 257 of file FrameDict.h.
◆ decompose()
|
protectedinherited |
Return a deep copy of one of the two component mappings.
This is intended to be exposed by classes that need it (e.g. CmpMap, CmpFrame and TranMap) as operator[].
- Parameters
-
[in] i Index: 0 for the first mapping, 1 for the second [in] copy If true make a deep copy, else a shallow copy
- Exceptions
-
std::invalid_argument if iis not 0 or 1.std::runtime_error if this mapping is not a compound mapping.
Definition at line 64 of file Mapping.cc.
◆ distance()
Find the distance between two points whose Frame coordinates are given.
The distance calculated is that along the geodesic curve that joins the two points. For example, in a basic Frame, the distance calculated will be the Cartesian distance along the straight line joining the two points. For a more specialised Frame describing a sky coordinate system, however, it would be the distance along the great circle passing through two sky positions.
- Parameters
-
[in] point1 The coordinates of the first point. [in] point2 The coordinates of the second point.
- Returns
- The distance between the two points.
Definition at line 474 of file Frame.h.
◆ findFrame()
|
inherited |
Find a coordinate system with specified characteristics.
Use a "template" Frame to search another Frame (or FrameSet) to identify a coordinate system which has a specified set of characteristics. If a suitable coordinate system can be found, the function returns a pointer to a FrameSet which describes the required coordinate system and how to convert coordinates to and from it.
This function is provided to help answer general questions about coordinate systems, such as typically arise when coordinate information is imported into a program as part of an initially unknown dataset. For example:
- Is there a wavelength scale?
- Is there a 2-dimensional coordinate system?
- Is there a celestial coordinate system?
- Can I plot the data in ecliptic coordinates?
You can also use this function as a means of reconciling a user's preference for a particular coordinate system (for example, what type of axes to draw) with what is actually possible given the coordinate information available.
To perform a search, you supply a "target" Frame (or FrameSet) which represents the set of coordinate systems to be searched. If a basic Frame is given as the target, this set of coordinate systems consists of the one described by this Frame, plus all other "virtual" coordinate systems which can potentially be reached from it by applying built-in conversions (for example, any of the celestial coordinate conversions known to the AST library would constitute a "built-in" conversion). If a FrameSet is given as the target, the set of coordinate systems to be searched consists of the union of those represented by all the individual Frames within it.
To select from this large set of possible coordinate systems, you supply a "template" Frame which is an instance of the type of Frame you are looking for. Effectively, you then ask the function to "find a coordinate system that looks like this".
You can make your request more or less specific by setting attribute values for the template Frame. If a particular attribute is set in the template, then the function will only find coordinate systems which have exactly the same value for that attribute. If you leave a template attribute un-set, however, then the function has discretion about the value the attribute should have in any coordinate system it finds. The attribute will then take its value from one of the actual (rather than virtual) coordinate systems in the target. If the target is a FrameSet, its Current attribute will be modified to indicate which of its Frames was used for this purpose.
The result of this process is a coordinate system represented by a hybrid Frame which acquires some attributes from the template (but only if they were set) and the remainder from the target. This represents the "best compromise" between what you asked for and what was available. A Mapping is then generated which converts from the target coordinate system to this hybrid one, and the returned FrameSet encapsulates all of this information.
Applicability to Subclasses
-
If the target is a FrameSet, the possibility exists that several of the Frames within it might be matched by the template. Unless the choice is sufficiently restricted by the "domainlist" string, the sequence in which Frames are searched can then become important. In this case, the search proceeds as follows:
- Each field in the "domainlist" string is considered in turn.
- An attempt is made to match the template to each of the target's Frames in the order: (1) the current Frame (2) the base Frame (3) each remaining Frame in the order of being added to the target FrameSet
- Generally, the first match found is used. However, the Mapping between the target coordinate system and the resulting Frame is also examined. Preference is given to cases where both the forward and inverse transformations are defined. If only one transformation is defined, the forward one is preferred.
- If a match is found and the domain of the resulting Frame also matches the current "domainlist" field, it is accepted. Otherwise, the next "domainlist" field is considered and the process repeated.
If a suitable coordinate system is found, then the FrameSet's Current attribute will be modified to indicate which Frame was used to obtain attribute values which were not specified by the template. This Frame will, in some sense, represent the "closest" non-virtual coordinate system to the one you requested.
Examples
auto result = target.findFrame(ast::Frame(3))Search for a 3-dimensional coordinate system in the target Frame (or FrameSet). No attributes have been set in the template Frame (created by ast::Frame), so no restriction has been placed on the required coordinate system, other than that it should have 3 dimensions. The first suitable Frame found will be returned as part of the "result" FrameSet.
auto result = target.findFrame(astSkyFrame())Search for a celestial coordinate system in the target Frame (or FrameSet). The type of celestial coordinate system is unspecified, so astFindFrame will return the first one found as part of the "result" FrameSet. If the target is a FrameSet, then its Current attribute will be updated to identify the Frame that was used.
auto result = target.findFrame(astSkyFrame("MaxAxes=100"))This is like the last example, except that in the event of the target being a CmpFrame, the component Frames encapsulated by the CmpFrame will be searched for a SkyFrame. If found, the returned Mapping will included a PermMap which selects the required axes from the target CmpFrame.
This is acomplished by setting the MaxAxes attribute of the template SkyFrame to a large number (larger than or equal to the number of axes in the target CmpFrame). This allows the SkyFrame to be used as a match for Frames containing from 2 to 100 axes.
auto result = target.findFrame(astSkyFrame("System=FK5"))Search for an equatorial (FK5) coordinate system in the target. The
Equinoxvalue for the coordinate system has not been specified, so will be obtained from the target. If the target is a FrameSet, itsCurrentattribute will be updated to indicate which SkyFrame was used to obtain this value.auto result = target.findFrame(astFrame(2), "sky,pixel,")Search for a 2-dimensional coordinate system in the target. Initially, a search is made for a suitable coordinate system whose Domain attribute has the value "SKY". If this search fails, a search is then made for one with the domain "PIXEL". If this also fails, then any 2-dimensional coordinate system is returned as part of the "result" FrameSet.
Only if no 2-dimensional coordinate systems can be reached by applying built-in conversions to any of the Frames in the target will the search fail.
auto result = target.findFrame(astFrame(1, "Domain=WAVELENGTH"))Searches for any 1-dimensional coordinate system in the target which has the domain "WAVELENGTH".
auto result = target.findFrame(astFrame(1), "wavelength")This example has exactly the same effect as that above. It illustrates the equivalence of the template's Domain attribute and the fields in the "domainlist" string.
auto result = target.findFrame(Frame(1, "MaxAxes=3"))This is a more advanced example which will search for any coordinate system in the target having 1, 2 or 3 dimensions. The Frame returned (as part of the "result" FrameSet) will always be 1-dimensional, but will be related to the coordinate system that was found by a suitable Mapping (e.g. a PermMap) which simply extracts the first axis.
If we had wanted a Frame representing the actual (1, 2 or 3-dimensional) coordinate system found, we could set the PreserveAxes attribute to a non-zero value in the template.
auto result = target.findFrame(SkyFrame("Permute=0"))Search for any celestial coordinate system in the target, but only finds one if its axes are in the conventional (longitude,latitude) order and have not been permuted (e.g. with astPermAxes).
More on Using Templates
A Frame (describing a coordinate system) will be found by this function if (a) it is "matched" by the template you supply, and (b) the value of its Domain attribute appears in the "domainlist" string (except that a blank field in this string permits any domain). A successful match by the template depends on a number of criteria, as outlined below:
- In general, a template will only match another Frame which belongs to the same class as the template, or to a derived (more specialised) class. For example, a SkyFrame template will match any other SkyFrame, but will not match a basic Frame. Conversely, a basic Frame template will match any class of Frame.
- The exception to this is that a Frame of any class can be used to match a CmpFrame, if that CmpFrame contains a Frame of the same class as the template. Note however, the MaxAxes and MinAxes attributes of the template must be set to suitable values to allow it to match the CmpFrame. That is, the MinAxes attribute must be less than or equal to the number of axes in the target, and the MaxAxes attribute must be greater than or equal to the number of axes in the target.
- If using a CmpFrame as a template frame, the MinAxes and MaxAxes for the template are determined by the MinAxes and MaxAxes values of the component Frames within the template. So if you want a template CmpFrame to be able to match Frames with different numbers of axes, then you must set the MaxAxes and/or MinAxes attributes in the component template Frames, before combining them together into the template CmpFrame.
- If a template has a value set for any of its main attributes, then it will only match Frames which have an identical value for that attribute (or which can be transformed, using a built-in conversion, so that they have the required value for that attribute). If any attribute in the template is un-set, however, then Frames are matched regardless of the value they may have for that attribute. You may therefore make a template more or less specific by choosing the attributes for which you set values. This requirement does not apply to 'descriptive' attributes such as titles, labels, symbols, etc.
- An important application of this principle involves the Domain attribute. Setting the Domain attribute of the template has the effect of restricting the search to a particular type of Frame (with the domain you specify). Conversely, if the Domain attribute is not set in the template, then the domain of the Frame found is not relevant, so all Frames are searched. Note that the "domainlist" string provides an alternative way of restricting the search in the same manner, but is a more convenient interface if you wish to search automatically for another domain if the first search fails.
- Normally, a template will only match a Frame which has the same number of axes as itself. However, for some classes of template, this default behaviour may be changed by means of the MinAxes, MaxAxes and MatchEnd attributes. In addition, the behaviour of a template may be influenced by its Permute and PreserveAxes attributes, which control whether it matches Frames whose axes have been permuted, and whether this permutation is retained in the Frame which is returned (as opposed to returning the axes in the order specified in the template, which is the default behaviour). You should consult the descriptions of these attributes for details of this more advanced use of templates.
- Parameters
-
[in,out] tmplt Template Frame, which should be an instance of the type of Frame you wish to find. If you wanted to find a Frame describing a celestial coordinate system, for example, then you might use a SkyFrame here. See the "Examples" section for more ideas. [in] domainlist String containing a comma-separated list of Frame domains. This may be used to establish a priority order for the different types of coordinate system that might be found. The function will first try to find a suitable coordinate system whose Domain attribute equals the first domain in this list. If this fails, the second domain in the list will be used, and so on, until a result is obtained. A blank domain (e.g. two consecutive commas) indicates that any coordinate system is acceptable (subject to the template) regardless of its domain. This list is case-insensitive and all white space is ignored. If you do not wish to restrict the domain in this way, you should supply an empty string.
- Returns
- A std::shared_ptr<FrameSet> which contains the Frame found and a description of how to convert to (and from) the coordinate system it represents. If the Frame is not found then return a null pointer.
This FrameSet will contain two Frames. Frame number 1 (its base Frame) represents the target coordinate system and will be the same as the (base Frame of the) target. Frame number 2 (its current Frame) will be a Frame representing the coordinate system which the function found. The Mapping which inter-relates these two Frames will describe how to convert between their respective coordinate systems. Note that a FrameSet may be used both as a Mapping and as a Frame. If the result is used as a Mapping, then it provides a means of converting coordinates from the target coordinate system into the new coordinate system that was found (and vice versa if its inverse transformation is selected). If it is used as a Frame, its attributes will describe the new coordinate system.
Notes
- This method is not const because if called on a FrameSet then the BASE frame of the FrameSet may be changed. No other kind of frame will be altered.
- Similarly the
tmplargument is not const because if it is a FrameSet then the BASE frame of the template may be changed. No other kind of frame will be altered. - The Mapping represented by the returned FrameSet results in alignment taking place in the coordinate system specified by the AlignSystem attribute of the "template" Frame. See the description of the AlignSystem for further details.
- Beware of setting the
Domainattribute of the template and then using a "domainlist" string which does not include the template's domain (or a blank field). If you do so, no coordinate system will be found.
Definition at line 41 of file Frame.cc.
◆ format()
|
inlineinherited |
Return a string containing the formatted (character) version of a coordinate value for a Frame axis.
The formatting applied is determined by the Frame's attributes and, in particular, by any Format attribute string that has been set for the axis. A suitable default format (based on the Digits attribute value) will be applied if necessary.
- Parameters
-
[in] axis The number of the Frame axis for which formatting is to be performed (axis numbering starts at 1 for the first axis). [in] value The coordinate value to be formatted.
◆ fromAstObject()
|
staticinherited |
Given a bare AST object pointer return a shared pointer to an ast::Object of the correct type.
The returned object takes ownership of the pointer. This is almost always what you want, for instance astDecompose returns shallow copies of the internal pointers.
- Template Parameters
-
Class The class of the returned shared pointer. (The actual class will be the correct class of rawPtr.)
- Parameters
-
[in] rawObj A bare AST object pointer [in] copy If True then make a deep copy of the pointer (and free the original)
Definition at line 138 of file Object.cc.
◆ fromString()
|
inlinestaticinherited |
◆ getActiveUnit()
|
inlineinherited |
◆ getAlignSystem()
|
inlineinherited |
Get AlignSystem: the coordinate system used by convert and findFrame to align Frames.
Definition at line 802 of file Frame.h.
◆ getAllDomains()
| std::set< std::string > ast::FrameDict::getAllDomains | ( | ) | const |
Get the domain names for all contained Frames (excluding frames with empty or defaulted domain names).
Definition at line 45 of file FrameDict.cc.
◆ getAllVariants()
|
inlineinherited |
Get AllVariants: a list of all variant mappings stored with the current Frame.
Definition at line 243 of file FrameSet.h.
◆ getB()
|
inlineprotectedinherited |
Get the value of an attribute as a bool.
If possible, the attribute value is converted to the type you request.
- Exceptions
-
std::runtime_error if the attribute does not exist or the value cannot be converted
◆ getBase()
|
inlineinherited |
Get Base: index of base Frame.
Definition at line 248 of file FrameSet.h.
◆ getBottom()
|
inlineinherited |
Get Bottom for one axis: the lowest axis value to display.
Definition at line 807 of file Frame.h.
◆ getC()
|
inlineprotectedinherited |
Get the value of an attribute as a string.
If possible, the attribute value is converted to the type you request.
- Exceptions
-
std::runtime_error if the attribute does not exist or the value cannot be converted
◆ getClassName()
|
inlineinherited |
Get Class: the name of the class (e.g.
Note: if AST returns "CmpMap" then the name will be changed to "SeriesMap" or "ParallelMap", as appropriate.
Definition at line 139 of file Object.h.
◆ getCurrent()
|
inlineinherited |
◆ getD()
|
inlineprotectedinherited |
Get the value of an attribute as a double.
If possible, the attribute value is converted to the type you request.
- Exceptions
-
std::runtime_error if the attribute does not exist or the value cannot be converted
◆ getDigits() [1/2]
|
inlineinherited |
◆ getDigits() [2/2]
|
inlineinherited |
◆ getDirection()
|
inlineinherited |
Get Direction for one axis: display axis in conventional direction?
Definition at line 822 of file Frame.h.
◆ getDomain()
|
inlineinherited |
◆ getDut1()
|
inlineinherited |
◆ getEpoch()
|
inlineinherited |
◆ getF()
|
inlineprotectedinherited |
Get the value of an attribute as a float.
If possible, the attribute value is converted to the type you request.
- Exceptions
-
std::runtime_error if the attribute does not exist or the value cannot be converted
◆ getFormat()
|
inlineinherited |
◆ getFrame() [1/2]
|
inline |
Obtain a deep copy of the specified Frame.
- Parameters
-
[in] iframe The index of the required Frame within this FrameSet. This value should lie in the range 1 to the number of frames already in this FrameSet (as given by getNFrame). A value of FrameSet::Base or FrameSet::CURRENT may be given to specify the base Frame or the current Frame, respectively. [in] copy If true return a deep copy, else a shallow copy.
- Warning
- : to permute axes of a frame in a FrameSet, such that the connecting mappings are updated: set the current frame to the frame in question and call
permAxesdirectly on the FrameSet. Do not callpermAxeson a shallow copy of the frame (retrieved by getFrame) as this will not affect the connected mappings.
Definition at line 270 of file FrameSet.h.
◆ getFrame() [2/2]
|
inline |
Variant of getFrame(int, bool) where the frame is specified by domain name.
- Exceptions
-
std::out_of_range if no frame found with the specified domain
Definition at line 151 of file FrameDict.h.
◆ getFrameSet()
|
inlineprotected |
Return a deep copy as a FrameSet.
This is used internally for operations that modify the contents:
- Retrieve a copy as a FrameSet
- Modify the copy
- Call _update to construct a new domain:index dict from the copy and swap in the new data
This could be a public member function, but wait until a need is identified.
Warning: this must return a FrameSet, not a FrameDict in order to avoid an infinite loop.
Definition at line 273 of file FrameDict.h.
◆ getI()
|
protectedinherited |
Get the value of an attribute as an int.
If possible, the attribute value is converted to the type you request.
- Exceptions
-
std::runtime_error if the attribute does not exist or the value cannot be converted
◆ getID()
|
inlineinherited |
◆ getIdent()
|
inlineinherited |
◆ getIndex()
|
inline |
Get the index of a frame specified by domain.
- Exceptions
-
std::out_of_range if no frame found with the specified domain
Definition at line 189 of file FrameDict.h.
◆ getInternalUnit()
|
inlineinherited |
Get InternalUnit(axis) read-only attribute for one axis: physical units for unformated axis values.
Definition at line 848 of file Frame.h.
◆ getIsLinear()
|
inlineinherited |
◆ getIsSimple()
|
inlineinherited |
◆ getL()
|
inlineprotectedinherited |
Get the value of an attribute as a long int.
If possible, the attribute value is converted to the type you request.
- Exceptions
-
std::runtime_error if the attribute does not exist or the value cannot be converted
◆ getLabel()
|
inlineinherited |
◆ getMapping() [1/4]
|
inline |
Variant of FrameSet::getMapping with the second frame specified by domain.
- Exceptions
-
std::out_of_range if no frame found with the specified from or to domain
Definition at line 162 of file FrameDict.h.
◆ getMapping() [2/4]
|
inline |
Obtain a Mapping that converts between two Frames in a FrameSet.
- Parameters
-
[in] from The index of the first Frame in the FrameSet, the frame describing the coordinate system for the "input" end of the Mapping. This value should lie in the range 1 to the number of frames already in this FrameSet (as given by getNFrame). [in] to The index of the second Frame in the FrameSet, the frame describing the coordinate system for the "output" end of the Mapping. This value should lie in the range 1 to the number of frames already in this FrameSet (as given by getNFrame).
- Returns
- A Mapping whose forward transformation converts coordinates from the first frame to the second one, and whose inverse transformation converts coordinates in the opposite direction.
Notes
- The returned Mapping will include the clipping effect of any Regions which occur on the path between the two supplied Frames, including the specified end frames.
- It should always be possible to generate the Mapping requested, but this does not necessarily guarantee that it will be able to perform the required coordinate conversion. If necessary, call
hasForwardorhasInverseon the returned Mapping to determine if the required transformation is available.
Definition at line 304 of file FrameSet.h.
◆ getMapping() [3/4]
|
inline |
Variant of FrameSet::getMapping with the first frame specified by domain.
- Exceptions
-
std::out_of_range if no frame found with the specified from or to domain
Definition at line 171 of file FrameDict.h.
◆ getMapping() [4/4]
|
inline |
Variant of FrameSet::getMapping with the both frames specified by domain.
- Exceptions
-
std::out_of_range if no frame found with the specified from or to domain
Definition at line 180 of file FrameDict.h.
◆ getMatchEnd()
|
inlineinherited |
◆ getMaxAxes()
|
inlineinherited |
◆ getMinAxes()
|
inlineinherited |
◆ getNAxes()
|
inlineinherited |
◆ getNFrame()
|
inlineinherited |
Get FrameSet_NFrame "NFrame": number of Frames in the FrameSet, starting from 1.
Definition at line 316 of file FrameSet.h.
◆ getNIn()
|
inlineinherited |
◆ getNObject()
|
inlineinherited |
◆ getNormUnit()
|
inlineinherited |
Get NormUnit(axis) read-only attribute for one frame: normalised physical units for formatted axis values.
Definition at line 882 of file Frame.h.
◆ getNOut()
|
inlineinherited |
◆ getObjSize()
|
inlineinherited |
◆ getObsAlt()
|
inlineinherited |
◆ getObsLat()
|
inlineinherited |
◆ getObsLon()
|
inlineinherited |
◆ getPermute()
|
inlineinherited |
◆ getPreserveAxes()
|
inlineinherited |
◆ getRawPtr() [1/2]
|
inlineinherited |
◆ getRawPtr() [2/2]
|
inlineinherited |
◆ getRefCount()
|
inlineinherited |
◆ getReport()
|
inlineinherited |
◆ getSymbol()
|
inlineinherited |
◆ getSystem()
|
inlineinherited |
◆ getTitle()
|
inlineinherited |
◆ getTop()
|
inlineinherited |
◆ getUnit()
|
inlineinherited |
Get Unit(axis) for one axis: physical units for formatted axis values.
Definition at line 933 of file Frame.h.
◆ getUseDefs()
|
inlineinherited |
◆ getVariant()
|
inlineinherited |
Variant: name of variant mapping in use by current Frame
See also addVariant, mirrorVariants and renameVariant
Definition at line 323 of file FrameSet.h.
◆ hasAttribute()
|
inlineinherited |
◆ hasDomain()
|
inline |
Return True if a frame in this FrameDict has the specified domain.
Definition at line 201 of file FrameDict.h.
◆ hasForward()
|
inlineinherited |
Is the forward transform available?
- Note
- This gets the TranForward attribute, but is named
hasForwardinstead ofgetTranForwardfor clarity, since it does not return a transform.
Definition at line 114 of file Mapping.h.
◆ hasInverse()
|
inlineinherited |
Is the inverse transform available?
- Note
- This gets the TranInverse attribute, but is named
hasInverseinstead ofgetTranInversefor clarity, since it does not return a transform.
Definition at line 123 of file Mapping.h.
◆ intersect()
|
inherited |
Find the point of intersection between two geodesic curves.
For example, in a basic Frame, it will find the point of intersection between two straight lines. But for a SkyFrame it will find an intersection of two great circles.
- Warning
- This method can only be used with 2-dimensional Frames.
- Parameters
-
[in] a1 Coordinates of the first point on the first geodesic curve. [in] a2 Coordinates of the second point on the first geodesic curve. [in] b1 Coordinates of the first point on the second geodesic curve. [in] b2 Coordinates of the second point on the second geodesic curve.
- Returns
- the point of intersection between the two geodesic curves.
- Exceptions
-
std::runtime_error if the frame is not 2-dimensional
Notes
- For a SkyFrame each curve will be a great circle, and in general each pair of curves will intersect at two diametrically opposite points on the sky. The returned position is the one which is closest to point
a1. - This method will return
nancoordinate values if any of the input coordinates is invalid, or if the two points defining either geodesic are coincident, or if the two curves do not intersect. - The geodesic curve used by this method is the path of shortest distance between two points, as defined by distance
Definition at line 51 of file Frame.cc.
◆ inverted()
|
inherited |
Get an inverse mapping.
An inverse mapping is a deep copy of a mapping whose Invert attribute has been toggled, as indicated by isInverted. This swaps the meaning of "input" and "output", and of "forward" and "inverse". Thus it swaps the behavior of applyForward and applyInverse, getNIn and getNOut, hasForward and hasInverse and so on.
Note that the inverse mapping contains exactly the same model coefficients as the original, but they are used by applyInverse instead of applyForward. Thus for example if a ZoomMap has a zoom factor of 4.0 then its inverse also reports a zoom factor of 4.0 (despite behaving like an uninverted ZoomMap with zoom factor of 0.25).
Definition at line 41 of file Mapping.cc.
◆ isInverted()
|
inlineinherited |
◆ linearApprox()
|
inherited |
Compute a linear approximation to the forward transformation.
- Parameters
-
[in] lbnd Input point defining the lower bounds of the box over which the linear approximation is computed. [in] ubnd Input point defining the upper bounds of the box over which the linear approximation is computed. [in] tol The maximum permitted deviation from linearity, expressed as apositive Cartesian displacement in the output coordinate space. If a linear fit to the forward transformation of the Mapping deviates from the true transformation by more than this amount at any point which is tested, then raise an exception.
- Returns
- The co-efficients of the linear approximation to the specified transformation, as an 1 + nIn x nOut array. The first index is [constant, gradiant for input 1, gradiant for input 2...] and the second index is [output 1, output 2, ...]. For example, if the Mapping has 2 inputs and 3 outputs then the coefficients are:
X_out = fit[0, 0] + fit[1, 0] X_in + fit[2, 0] Y_in Y_out = fit[0, 1] + fit[1, 1] X_in + fit[2, 1] Y_in Z_out = fit[0, 2] + fit[1, 2] X_in + fit[2, 2] Y_in
- Exceptions
-
std::runtime_error if the forward transformation cannot be modeled to within the specified tol.
Definition at line 49 of file Mapping.cc.
◆ lock()
|
inlineinherited |
Lock this object for exclusive use by the calling thread.
The thread-safe public interface to AST is designed so that an error is reported if any thread attempts to use an Object that it has not previously locked for its own exclusive use using this function. When an Object is created, it is initially locked by the thread that creates it, so newly created objects do not need to be explicitly locked. However, if an Object pointer is passed to another thread, the original thread must first unlock it (using astUnlock) and the new thread must then lock it (using astLock) before the new thread can use the Object.
- Parameters
-
[in] wait If the Object is curently locked by another thread then this function will either report an error or block. If a non-zero value is supplied for "wait", the calling thread waits until the object is available for it to use. Otherwise, an error is reported and the function returns immediately without locking the Object.
Notes
- The Locked object will belong to the current AST context.
- This function returns without action if the Object is already locked by the calling thread.
- If simultaneous use of the same object is required by two or more threads, Object::copy should be used to to produce a deep copy of the Object for each thread. Each copy should then be unlocked by the parent thread (i.e. the thread that created the copy), and then locked by the child thread (i.e. the thread that wants to use the copy).
- This function returns without action if the AST library has been built without POSIX thread support (i.e. the "-with-pthreads" option was not specified when running the "configure" script).
◆ makeShim()
|
inlinestaticprotectedinherited |
Functor to make an astshim instance from a raw AST pointer of the corresponding type.
- Template Parameters
-
ShimT Output astshim class AstT Output AST class
◆ matchAxes()
|
inlineinherited |
Look for corresponding axes between this frame and another.
- Parameters
-
[in] other The other frame
- Returns
- The indices of the axes (within this Frame) that correspond to each axis within
other. Axis indices start at 1. A value of zero will be stored in the returned array for each axis inotherthat has no corresponding axis in this frame. The number of elements in the array will be the number of axes inother.
Notes
- Corresponding axes are identified by the fact that a
Mappingcan be found between them usingfindFrameorconvert. Thus, "corresponding axes" are not necessarily identical. For instance,SkyFrameaxes will match even if they describe different celestial coordinate systems.
Definition at line 985 of file Frame.h.
◆ mirrorVariants() [1/2]
|
inline |
Indicates that all access to the Variant attribute of the current Frame should should be forwarded to some other nominated Frame in the FrameSet.
For instance, if a value is set subsequently for the Variant attribute of the current Frame, the current Frame will be left unchanged and the setting is instead applied to the nominated Frame. Likewise, if the value of the Variant attribute is requested, the value returned is the value stored for the nominated Frame rather than the current Frame itself.
This provides a mechanism for propagating the effects of variant Mappings around a FrameSet. If a new Frame is added to a FrameSet by connecting it to an pre-existing Frame that has two or more variant Mappings, then it may be appropriate to set the new Frame so that it mirrors the variants Mappings of the pre-existing Frame. If this is done, then it will be possible to select a specific variant Mapping using either the pre-existing Frame or the new Frame.
See also addVariant, getVariant and renameVariant.
- Parameters
-
[in] iframe The index of the Frame within the FrameSet which is to be mirrored by the current Frame. This value should lie in the range from 1 to the number of Frames in the FrameSet (as given by getNFrame). If AST__NOFRAMEis supplied (or the current Frame is specified), then any mirroring established by a previous call to this function is disabled. A value of FrameSet::BASE may be given to specify the base frame.
Notes:
- Mirrors can be chained. That is, if Frame B is set to be a mirror of Frame A, and Frame C is set to be a mirror of Frame B, then Frame C will act as a mirror of Frame A.
- Variant Mappings cannot be added to the current Frame if it is mirroring another Frame. So calls to addVariant will cause an error to be reported if the current Frame is mirroring another Frame.
- Any variant Mappings explicitly added to the current Frame using addVariant will be ignored if the current Frame is mirroring another Frame.
Definition at line 367 of file FrameSet.h.
◆ mirrorVariants() [2/2]
|
inline |
Variant of mirrorVariants(int) with the frame specified by domain.
- Exceptions
-
std::out_of_range if no frame found with the specified domain
Definition at line 210 of file FrameDict.h.
◆ norm()
Normalise a set of Frame coordinate values which might be unsuitable for display (e.g.
may lie outside the expected range) into a set of acceptable values suitable for display.
- Parameters
-
[in] value A point in the space which the Frame describes.
- Returns
- Normalized version of
value. If any axes ofvaluelie outside the expected range for the Frame, the corresponding returned value is changed to a acceptable (normalised) value. Otherwise, the axes ofvalueare returned unchanged.
Notes
- For some classes of Frame, whose coordinate values are not constrained, this function will always return the input unchanged. However, for Frames whose axes represent cyclic quantities (such as angles or positions on the sky), the output coordinates will typically be wrapped into an appropriate standard range, such as [0, 2 pi].
- The NormMap class is a Mapping which can be used to normalise a set of points using the
normfunction of a specified Frame. - It is intended to be possible to put any set of coordinates into a form suitable for display by using this function to normalise them, followed by appropriate formatting (using astFormat).
◆ offset()
Find the point which is offset a specified distance along the geodesic curve between two other points.
For example, in a basic Frame, this offset will be along the straight line joining two points. For a more specialised Frame describing a sky coordinate system, however, it would be along the great circle passing through two sky positions.
- Parameters
-
[in] point1 The point marking the start of the geodesic curve. [in] point2 The point marking the end of the geodesic curve. [in] offset The required offset from the first point along the geodesic curve. If this is positive, it will be towards the second point. If it is negative, it will be in the opposite direction. This offset need not imply a position lying between the two points given, as the curve will be extrapolated if necessary.
- Returns
- the offset point
Notes:
- The geodesic curve used by this function is the path of shortest distance between two points, as defined by the
distancefunction.
- Exceptions
-
std::invalid_argument if: - point1 or point2 is the wrong length
Definition at line 1075 of file Frame.h.
◆ offset2()
|
inlineinherited |
Find the point which is offset a specified distance along the geodesic curve at a given angle from a specified starting point.
This can only be used with 2-dimensional Frames.
For example, in a basic Frame, this offset will be along the straight line joining two points. For a more specialised Frame describing a sky coordinate system, however, it would be along the great circle passing through two sky positions.
- Parameters
-
[in] point1 The point marking the start of the geodesic curve. [in] angle The angle (in radians) from the positive direction of the second axis, to the direction of the required position, as seen from the starting position. Positive rotation is in the sense of rotation from the positive direction of axis 2 to the positive direction of axis 1. [in] offset The required offset from the first point along the geodesic curve. If this is positive, it will be in the direction of the given angle. If it is negative, it will be in the opposite direction.
- Returns
- a DirectionPoint containing:
- The direction of the geodesic curve at the end point. That is, the angle (in radians) between the positive direction of the second axis and the continuation of the geodesic curve at the requested end point. Positive rotation is in the sense of rotation from the positive direction of axis 2 to the positive direction of axis 1.
- The offset point.
- Exceptions
-
std::invalid_argument if - frame does not have naxes = 2
- point1 or point2 are the wrong length, or point1 has any
AST__BADvalues
Notes
- The geodesic curve used by this function is the path of shortest distance between two points, as defined by the astDistance function
Definition at line 1117 of file Frame.h.
◆ operator!=()
|
inlineinherited |
◆ operator=() [1/2]
◆ operator=() [2/2]
◆ operator==()
|
inherited |
Return True if this and rhs are the equal.
For two objects be equal, they both must have the same attributes and all contained objects must be equal.
Definition at line 85 of file Object.cc.
◆ permAxes()
|
inlineinherited |
Permute the order in which a Frame's axes occur.
- Parameters
-
[in] perm A list of axes in their new order, using the current axis numbering. Axis numbers start at 1 for the first axis. Only genuine permutations of the axis order are permitted, so each axis must be referenced exactly once.
When used on a FrameSet, the axes of the current frame are permuted and all connecting mappings are updated accordingly, so that current behavior is preserved (except for the new axis order for output data).
Definition at line 1138 of file Frame.h.
◆ pickAxes()
|
inherited |
Create a new Frame whose axes are copied from an existing Frame along with other Frame attributes, such as its Title.
Any number (zero or more) of the original Frame's axes may be copied, in any order, and additional axes with default attributes may also be included in the new Frame.
- Parameters
-
[in] axes the axes to be copied. These should be given in the order required in the new Frame, using the axis numbering in the original Frame (which starts at 1 for the first axis). Axes may be selected in any order, but each may only be used once. If additional (default) axes are also to be included, the corresponding elements of this array should be set to zero.
- Returns
- a FrameMapping containing:
Definition at line 68 of file Frame.cc.
◆ rate()
|
inlineinherited |
Evaluate the rate of change of the Mapping with respect to a specified input, at a specified position.
The result is estimated by interpolating the function using a fourth order polynomial in the neighbourhood of the specified position. The size of the neighbourhood used is chosen to minimise the RMS residual per unit length between the interpolating polynomial and the supplied Mapping function. This method produces good accuracy but can involve evaluating the Mapping 100 or more times.
- Parameters
-
[in] at The input position at which the rate of change is to be evaluated. [in] ax1 The index of the output for which the rate of change is to be found (1 for first output). [in] ax2 The index of the input which is to be varied in order to find the rate of change (1 for the first input).
- Returns
- The rate of change of Mapping output
ax1with respect to inputax2, evaluated atat, ornanif the value cannot be calculated.
◆ remapFrame() [1/2]
|
inline |
Modify the relationship (i.e.
Mapping) between a specified Frame in a FrameSet and the other Frames in that FrameSet.
Typically, this might be required if the FrameSet has been used to calibrate (say) an image, and that image is re-binned. The Frame describing the image will then have undergone a coordinate transformation, and this should be communicated to the associated FrameSet using this function.
See also addVariant, getVariant and mirrorVariants.
- Parameters
-
[in] iframe The index within the FrameSet of the Frame to be modified. This value should lie in the range 1 to the number of frames already in this FrameSet (as given by getNFrame). A value of FrameSet::BASE or FrameSet::CURRENT may be given to specify the base Frame or the current Frame respectively. [in] map A Mapping whose forward transformation converts coordinate values from the original coordinate system described by the Frame to the new one, and whose inverse transformation converts in the opposite direction.
Notes
- The relationship between the selected Frame and any other Frame within the FrameSet will be modified by this function, but the relationship between all other Frames in the FrameSet remains unchanged.
- The number of input and output coordinate values of the Mapping must be equal and must match the number of axes in the Frame being modified.
- If a simple change of axis order is required, then permAxes may provide a more straightforward method of making the required changes to the FrameSet.
- This function cannot be used to change the number of Frame axes. To achieve this, a new Frame must be added to the FrameSet (with addFrame) and the original one removed if necessary (with removeFrame).
- Any variant Mappings associated with the remapped Frame (except for the current variant) will be lost as a consequence of calling this method (see attribute
Variant).
Definition at line 410 of file FrameSet.h.
◆ remapFrame() [2/2]
|
inline |
Variant of remapFrame(int, Mapping&) with the frame specified by domain.
- Exceptions
-
std::out_of_range if no frame found with the specified domain
Definition at line 219 of file FrameDict.h.
◆ removeFrame() [1/2]
|
overridevirtual |
Remove a Frame from a FrameSet.
Other Frame indices in the FrameSet are re-numbered as follows: Frame indices greater than iframe are decremented by one; other Frame indeces retain the same index.
- Parameters
-
[in] iframe The index of the required Frame within this FrameSet. This value should lie in the range 1 to the number of Frames in this FrameSet (as given by getNFrame). A value of FrameSet::BASE or FrameSet::CURRENT may be given to specify the base Frame or the current Frame, respectively.
Notes
- Removing a Frame from a FrameSet does not affect the relationship between other Frames in this FrameSet, even if they originally depended on the Frame being removed.
- The number of Frames in a FrameSet cannot be reduced to zero.
- If a FrameSet's base or current Frame is removed, the
BaseorCurrentattribute (respectively) of the FrameSet will have its value cleared, so that another Frame will then assume its role by default. - If any other Frame is removed, the base and current Frames will remain the same. To ensure this, the
Baseand/orCurrentattributes of the FrameSet will be changed, if necessary, to reflect any change in the indices of these Frames.
- Exceptions
-
std::runtime_error if you attempt to remove the last frame
Reimplemented from ast::FrameSet.
Definition at line 53 of file FrameDict.cc.
◆ removeFrame() [2/2]
| void ast::FrameDict::removeFrame | ( | std::string const & | domain | ) |
Variant of removeFrame(int) with the frame specified by domain.
- Exceptions
-
std::out_of_range if no frame found with the specified domain
Definition at line 59 of file FrameDict.cc.
◆ renameVariant()
|
inlineinherited |
Rename the current Variant of the current Mapping.
The Variant attribute is updated to name.
See the Variant attribute for more details. See also addVariant, getVariant and mirrorVariants.
- Parameters
-
[in] name The new name of the current variant Mapping.
- Exceptions
-
std::runtime_error if:
Definition at line 463 of file FrameSet.h.
◆ resolve()
|
inherited |
Resolve a vector into two orthogonal components.
The vector from point 1 to point 2 is used as the basis vector. The vector from point 1 to point 3 is resolved into components parallel and perpendicular to this basis vector. The lengths of the two components are returned, together with the position of closest aproach of the basis vector to point 3.
- Parameters
-
[in] point1 The start of the basis vector, and of the vector to be resolved. [in] point2 The end of the basis vector. [in] point3 The end of the vector to be resolved.
- Returns
- a ResolvedPoint containing:
- point The point of closest approach of the basis vector to point 3.
- d1 The distance from point 1 to the returned point (that is, the length of the component parallel to the basis vector). Positive values are in the same sense as movement from point 1 to point 2.
- d2 The distance from the returned point to point 3 (that is, the length of the component perpendicular to the basis vector). The value is always positive.
Notes
- Each vector used in this method is the path of shortest distance between two points, as defined by distance
- This method will return
nancoordinate values if any of the input coordinates are invalid, or if the required output values are undefined.
◆ same()
|
inlineinherited |
◆ set()
|
inlineprotectedinherited |
Assign a set of attribute values, over-riding any previous values.
The attributes and their new values are specified via a character string, which should contain a comma-separated list of the form: "attribute_1 = value_1, attribute_2 = value_2, ... " where "attribute_n" specifies an attribute name, and the value to the right of each " =" sign should be a suitable textual representation of the value to be assigned. This value will be interpreted according to the attribute's data type.
Notes
- Attribute names are not case sensitive and may be surrounded by white space
- Attribute names are not case sensitive and may be surrounded by white space.
- White space may also surround attribute values, where it will generally be ignored (except for string-valued attributes where it is significant and forms part of the value to be assigned).
- To include a literal comma or percent sign in the value assigned to an attribute, the whole attribute value should be enclosed in quotation markes.
- Exceptions
-
std::runtime_error if the attribute is read-only
◆ setActiveUnit()
|
inlineinherited |
◆ setAlignSystem()
|
inlineinherited |
Set AlignSystem: the coordinate system used by convert and findFrame to align Frames.
Definition at line 1203 of file Frame.h.
◆ setB()
|
inlineprotectedinherited |
Set the value of an attribute as a bool.
If possible, the type you provide is converted to the actual type of the attribute.
- Exceptions
-
std::runtime_error if the attribute does not exist or the value cannot be converted
◆ setBase() [1/2]
|
inline |
Set Base: index of base Frame.
Definition at line 471 of file FrameSet.h.
◆ setBase() [2/2]
|
inline |
Variant of setBase(int) with the frame specified by domain.
- Exceptions
-
std::out_of_range if no frame found with the specified domain
Definition at line 238 of file FrameDict.h.
◆ setBottom()
|
inlineinherited |
Set Bottom: the lowest axis value to display.
Definition at line 1208 of file Frame.h.
◆ setC()
|
inlineprotectedinherited |
Set the value of an attribute as a string.
If possible, the type you provide is converted to the actual type of the attribute.
- Exceptions
-
std::runtime_error if the attribute does not exist or the value cannot be converted
◆ setCurrent() [1/2]
|
inline |
◆ setCurrent() [2/2]
|
inline |
Variant of setCurrent(int) with the frame specified by domain.
- Exceptions
-
std::out_of_range if no frame found with the specified domain
Definition at line 247 of file FrameDict.h.
◆ setD()
|
inlineprotectedinherited |
Set the value of an attribute as a double.
If possible, the type you provide is converted to the actual type of the attribute.
- Exceptions
-
std::runtime_error if the attribute does not exist or the value cannot be converted
◆ setDigits() [1/2]
|
inlineinherited |
◆ setDigits() [2/2]
|
inlineinherited |
◆ setDirection()
|
inlineinherited |
Set Direction for one axis: display axis in conventional direction?
Definition at line 1223 of file Frame.h.
◆ setDomain()
|
overridevirtual |
Set the domain of the current frame (and update the internal dict).
- Exceptions
-
std::invalid_argument if another frame already has this domain
Reimplemented from ast::Frame.
Definition at line 61 of file FrameDict.cc.
◆ setDut1()
|
inlineinherited |
◆ setEpoch() [1/2]
|
inlineinherited |
◆ setEpoch() [2/2]
|
inlineinherited |
◆ setF()
|
inlineprotectedinherited |
Set the value of an attribute as a float.
If possible, the type you provide is converted to the actual type of the attribute.
- Exceptions
-
std::runtime_error if the attribute does not exist or the value cannot be converted
◆ setFormat()
|
inlineinherited |
Set Format for one axis: format specification for axis values.
Definition at line 1250 of file Frame.h.
◆ setI()
|
inlineprotectedinherited |
Set the value of an attribute as an int.
If possible, the type you provide is converted to the actual type of the attribute.
- Exceptions
-
std::runtime_error if the attribute does not exist or the value cannot be converted
◆ setID()
|
inlineinherited |
◆ setIdent()
|
inlineinherited |
◆ setL()
|
inlineprotectedinherited |
Set the value of an attribute as a long int.
If possible, the type you provide is converted to the actual type of the attribute.
- Exceptions
-
std::runtime_error if the attribute does not exist or the value cannot be converted
◆ setLabel()
|
inlineinherited |
◆ setMatchEnd()
|
inlineinherited |
◆ setMaxAxes()
|
inlineinherited |
◆ setMinAxes()
|
inlineinherited |
◆ setObsAlt()
|
inlineinherited |
◆ setObsLat()
|
inlineinherited |
◆ setObsLon()
|
inlineinherited |
◆ setPermute()
|
inlineinherited |
◆ setPreserveAxes()
|
inlineinherited |
◆ setReport()
|
inlineinherited |
◆ setSymbol()
|
inlineinherited |
Set Symbol(axis) for one axis: axis symbol.
◆ setSystem()
|
inlineinherited |
◆ setTitle()
|
inlineinherited |
◆ setTop()
|
inlineinherited |
◆ setUnit()
|
inlineinherited |
Set Unit(axis) for one axis: physical units for formatted axis values.
Definition at line 1336 of file Frame.h.
◆ setUseDefs()
|
inlineinherited |
◆ show() [1/2]
|
inherited |
Return a textual description the object as a string.
- Parameters
-
[in] showComments Show comments?
◆ show() [2/2]
|
inherited |
Print a textual description the object to an ostream.
- Parameters
-
[in,out] os The stream to which to write the string representation. [in] showComments Show comments?
Definition at line 158 of file Object.cc.
◆ simplified()
|
inlineinherited |
Return a simplied version of the mapping (which may be a compound Mapping such as a CmpMap).
Simplification eliminates redundant computational steps and merges separate steps which can be performed more efficiently in a single operation. As a simple example, a Mapping which multiplied coordinates by 5, and then multiplied the result by 10, could be simplified to a single step which multiplied by 50. Similarly, a Mapping which multiplied by 5, and then divided by 5, could be reduced to a simple copying operation.
This function should typically be applied to Mappings which have undergone substantial processing or have been formed by merging other Mappings. It is of potential benefit, for example, in reducing execution time if applied before using a Mapping to transform a large number of coordinates.
- Note
- If the supplied Mapping is a FrameSet, the returned Mapping will be a deep copy of the supplied FrameSet in which all the inter-Frame Mappings have been simplified. Mappings that have a set value for their ref Object_Ident "Ident" attribute are unchanged by simplification. This is so that their individual identity is preserved. This restriction does not apply to the simplification of Frames. The returned mapping is always independent of the original (a deep copy), unlike astSimplify.
◆ test()
|
inlineinherited |
Has this attribute been explicitly set (and not subsequently cleared)?
- Warning
- Unlike the underlying astTest function, throws an exception if an error results
Notes
- Attribute names are not case sensitive and may be surrounded by white space.
- As you might expect, the returned value for a read-only attribute is always
false.
- Exceptions
-
std::runtime_error if an error results.
◆ then()
Return a series compound mapping this(first(input)) containing shallow copies of the original.
- Parameters
-
[in] next the mapping whose input is the output of this mapping
- Exceptions
-
std::invalid_argument if the number of input axes of nextdoes not match the number of output axes of this mapping.
- Warning
- The contained mappings are shallow copies (just like AST); if you want deep copies then make them manually.
Definition at line 37 of file Mapping.cc.
◆ tranGridForward() [1/2]
|
inlineinherited |
Transform a grid of points in the forward direction.
- Parameters
-
[in] lbnd The coordinates of the centre of the first pixel in the input grid along each dimension, size = nIn [in] ubnd The coordinates of the centre of the last pixel in the input grid along each dimension, size = nIn [in] tol The maximum tolerable geometrical distortion which may be introduced as a result of approximating non-linear Mappings by a set of piece-wise linear transformations. This should be expressed as a displacement within the output coordinate system of the Mapping.
If piece-wise linear approximation is not required, a value of zero may be given. This will ensure that the Mapping is used without any approximation, but may increase execution time.
If the value is too high, discontinuities between the linear approximations used in adjacent panel will be higher. If this is a problem, reduce the tolerance value used.
- Parameters
-
[in] maxpix A value which specifies an initial scale size (in input grid points) for the adaptive algorithm which approximates non-linear Mappings with piece-wise linear transformations. Normally, this should be a large value (larger than any dimension of the region of the input grid being used). In this case, a first attempt to approximate the Mapping by a linear transformation will be made over the entire input region. If a smaller value is used, the input region will first be divided into sub-regions whose size does not exceed " maxpix" grid points in any dimension. Only at this point will attempts at approximation commence. This value may occasionally be useful in preventing false convergence of the adaptive algorithm in cases where the Mapping appears approximately linear on large scales, but has irregularities (e.g. holes) on smaller scales. A value of, say, 50 to 100 grid points can also be employed as a safeguard in general-purpose software, since the effect on performance is minimal. If too small a value is given, it will have the effect of inhibiting linear approximation altogether (equivalent to setting " tol" to zero). Although this may degrade performance, accurate results will still be obtained. [in] to Computed points, with dimensions (nPts, nOut), where nPts the desired number of points
Definition at line 358 of file Mapping.h.
◆ tranGridForward() [2/2]
|
inlineinherited |
Transform a grid of points in the inverse direction, returning the results as a new Array2D.
See the overload of tranGridForward that outputs the data as the last argument for more information
◆ tranGridInverse() [1/2]
◆ tranGridInverse() [2/2]
◆ under() [1/2]
Combine this frame with another to form a compound frame (CmpFrame), with the axes of this frame followed by the axes of the next frame.
A compound frame allows two component Frames (of any class) to be merged together to form a more complex Frame. The axes of the two component Frames then appear together in the resulting CmpFrame (those of this Frame, followed by those of next).
Since a CmpFrame is itself a Frame, it can be used as a component in forming further CmpFrames. Frames of arbitrary complexity may be built from simple individual Frames in this way.
Also since a Frame is a Mapping, a CmpFrame can also be used as a Mapping. Normally, a CmpFrame is simply equivalent to a UnitMap, but if either of the component Frames within a CmpFrame is a Region (a sub-class of Frame), then the CmpFrame will use the Region as a Mapping when transforming values for axes described by the Region. Thus input axis values corresponding to positions which are outside the Region will result in bad output axis values.
The name comes the way vectors are sometimes shown for matrix multiplication: vertically, with the first axis at the bottom and the last axis at the top.
- Parameters
-
[in] next The next frame in the compound frame (the final next.getNAxes() axes)
- Returns
- a new CmpFrame
- Warning
- The contained frames are shallow copies (just like AST); if you want deep copies then make them manually.
Definition at line 66 of file Frame.cc.
◆ under() [2/2]
|
inherited |
Return a parallel compound mapping containing shallow copies of the original.
The resulting mapping has getNIn() + next.getNIn() inputs and getNOut() + next.getNOut() outputs. The first getNIn() axes of input are transformed by this mapping, producing the first getNOut() axes of output. The remaining axes of input are processed by next, resulting in the remaining axes of output.
The name comes the way vectors are sometimes shown for matrix multiplication: vertically, with the first axis at the bottom and the last axis at the top.
- Parameters
-
[in] next the mapping that processes the final next.getNin()axes of input to produce the finalnext.getNout()axes of output.
- Warning
- The contained mappings are shallow copies (just like AST); if you want deep copies then make them manually.
Definition at line 39 of file Mapping.cc.
◆ unformat()
|
inlineinherited |
Read a formatted coordinate value (given as a character string) for a Frame axis and return the number of characters read and the value.
The principle use of this function is in decoding user-supplied input which contains formatted coordinate values. Free-format input is supported as far as possible. If input is ambiguous, it is interpreted with reference to the Frame's attributes (in particular, the Format string associated with the Frame's axis).
This function is, in essence, the inverse of astFormat.
Applicability:
Frame This function applies to all Frames. See the "Frame Input Format" section below for details of the input formats accepted by a basic Frame.
SkyFrame The SkyFrame class re-defines the input format to be suitable for representing angles and times, with the resulting coordinate value returned in radians. See the "SkyFrame Input Format" section below for details of the formats accepted.
FrameSet The input formats accepted by a FrameSet are determined by its current Frame (as specified by the Current attribute).
Frame Input Format:
The input format accepted for a basic Frame axis is as follows:
- An optional sign, followed by:
- A sequence of one or more digits possibly containing a decimal point, followed by:
- An optional exponent field.
- The exponent field, if present, consists of "E" or "e" followed by a possibly signed integer.
Examples of acceptable Frame input formats include:
991.25-1.61E8-.99e-17<bad>
SkyFrame Input Format:
The input format accepted for a SkyFrame axis is as follows:
- An optional sign, followed by between one and three fields representing either degrees, arc-minutes, arc-seconds or hours, minutes, seconds (e.g. "-12 42 03").
- Each field should consist of a sequence of one or more digits, which may include leading zeros. At most one field may contain a decimal point, in which case it is taken to be the final field (e.g. decimal degrees might be given as "124.707", while degrees and decimal arc-minutes might be given as "-13 33.8").
- The first field given may take any value, allowing angles and times outside the conventional ranges to be represented. However, subsequent fields must have values of less than 60 (e.g. "720 45 31" is valid, whereas "11 45 61" is not).
- Fields may be separated by white space or by ":" (colon), but the choice of separator must be used consistently throughout the value. Additional white space may be present around fields and separators (e.g. "- 2: 04 : 7.1").
- The following field identification characters may be used as separators to replace either of those above (or may be appended to the final field), in order to identify the field to which they are appended: "d"—degrees; "h"—hours; "m"—minutes of arc or time; "s"—seconds of arc or time; "'" (single quote)—minutes of arc; """ (double quote)—seconds of arc. Either lower or upper case may be used. Fields must be given in order of decreasing significance (e.g. "-11D 3' 14.4"" or "22h14m11.2s").
- The presence of any of the field identification characters "d", "'" (single quote) or """ (double quote) indicates that the value is to be interpreted as an angle. Conversely, the presence of "h" indicates that it is to be interpreted as a time (with 24 hours corresponding to 360 degrees). Incompatible angle/time identification characters may not be mixed (e.g. "10h14'3"" is not valid). The remaining field identification characters and separators do not specify a preference for an angle or a time and may be used with either.
- If no preference for an angle or a time is expressed anywhere within the value, it is interpreted as an angle if the Format attribute string associated with the SkyFrame axis generates an angle and as a time otherwise. This ensures that values produced by astFormat are correctly interpreted by Frame.unformat.
- If no preference for an angle or a time is expressed anywhere within the value, it is interpreted as an angle if the Format attribute string associated with the SkyFrame axis generates an angle and as a time otherwise. This ensures that values produced by Frame.format are correctly interpreted by Frame.unformat.
- Fields may be omitted, in which case they default to zero. The remaining fields may be identified by using appropriate field identification characters (see above) and/or by adding extra colon separators (e.g. "-05m13s" is equivalent to "-:05:13"). If a field is not identified explicitly, it is assumed that adjacent fields have been given, after taking account of any extra separator characters (e.g. "14:25.4s" specifies minutes and seconds, while "14::25.4s" specifies degrees and seconds).
- If fields are omitted in such a way that the remaining ones cannot be identified uniquely (e.g. "01:02"), then the first field (either given explicitly or implied by an extra leading colon separator) is taken to be the most significant field that astFormat would produce when formatting a value (using the Format attribute associated with the SkyFrame axis). By default, this means that the first field will normally be interpreted as degrees or hours. However, if this does not result in consistent field identification, then the last field (either given explicitly or implied by an extra trailing colon separator) is taken to to be the least significant field that astFormat would produce.
- If fields are omitted in such a way that the remaining ones cannot be identified uniquely (e.g. "01:02"), then the first field (either given explicitly or implied by an extra leading colon separator) is taken to be the most significant field that Frame.format would produce when formatting a value (using the Format attribute associated with the SkyFrame axis). By default, this means that the first field will normally be interpreted as degrees or hours. However, if this does not result in consistent field identification, then the last field (either given explicitly or implied by an extra trailing colon separator) is taken to to be the least significant field that Frame.format would produce.
This final convention is intended to ensure that values formatted by Frame.format which contain less than three fields will be correctly interpreted if read back using Frame.unformat, even if they do not contain field identification characters.
Examples of acceptable SkyFrame input formats (with interpretation in parentheses) include:
- ‘-14d 13m 22.2s (-14d 13’ 22.2")` - `+ 12:34:56.7` (12d 34' 56.7" or 12h 34m 56.7s)
001 : 02 : 03.4(1d 02' 03.4" or 1h 02m 03.4s) - <tt>22h 30</tt> (22h 30m 00s) - <tt>136::10" (136d 00' 10" or 136h 00m 10s) - `-14M 27S` (-0d 14' 27" or -0h 14m 27s)-:14:(-0d 14' 00" or -0h 14m 00s) - `-::4.1` (-0d 00' 04.1" or -0h 00m 04.1s).9"</tt> (0d 00' 00.9")`d12m` (0d 12' 00") - <tt>H 12:22.3s</tt> (0h 12m 22.3s) - <tt>\<bad\></tt> (<tt>AST__BAD</tt>) Where alternative interpretations are shown, the choice of angle or time depends on the associated Format(axis) attribute. @param [in] axis The number of the Frame axis for which the coordinate value is to be read (axis numbering starts at zero for the first axis). @param [in] str String containing the formatted coordinate value. @return an NReadValue containing the number of characters read and the value; if nread is 0 then the value is certainly invalid. <h3>Notes</h3> - Any white space at the beginning of the string will be skipped, as also will any trailing white space following the coordinate value read. The number of characters read will reflect this. - The number of characters will be 0 and the value undefined if the string supplied does not contain a suitably formatted value. - The string "<bad>" is recognised as a special case and will generate the value AST__BAD, without error. The test for this string is case-insensitive and permits embedded white space.
◆ unlock()
|
inlineinherited |
Unlock this object previously locked using lock, so that other threads can use this object.
See lock for further details.
- Parameters
-
[in] report If true, an error will be reported if the supplied Object, or any Object contained within the supplied Object, is not currently locked by the running thread. If false, such Objects will be left unchanged, and no error will be reported.
Notes
- This function attempts to execute even if AST's global error status is set, but no further error report will be made if it subsequently fails under these circumstances.
- All unlocked Objects are excluded from AST context handling until they are re-locked using astLock.
- This function returns without action if the Object is not currently locked by any thread. If it is locked by the running thread, it is unlocked. If it is locked by another thread, an error will be reported if "error" is non-zero.
- This function returns without action if the AST library has been built without POSIX thread support (i.e. the "-with-pthreads" option was not specified when running the "configure" script).
Friends And Related Symbol Documentation
◆ Object
|
friend |
Definition at line 68 of file FrameDict.h.
Member Data Documentation
◆ BASE
|
staticconstexprinherited |
index of base frame
Definition at line 104 of file FrameSet.h.
◆ CURRENT
|
staticconstexprinherited |
index of current frame
Definition at line 105 of file FrameSet.h.
◆ NOFRAME
|
staticconstexprinherited |
an invalid frame index
Definition at line 106 of file FrameSet.h.
The documentation for this class was generated from the following files:
- /j/snowflake/release/lsstsw/stack/lsst-scipipe-9.0.0/Linux64/astshim/g3156d2b45e+41e33cbcdc/include/astshim/FrameDict.h
- /j/snowflake/release/lsstsw/stack/lsst-scipipe-9.0.0/Linux64/astshim/g3156d2b45e+41e33cbcdc/src/FrameDict.cc
