ast::Frame Class Reference

Frame is used to represent a coordinate system. More...

#include <Frame.h>

Inheritance diagram for ast::Frame:

Public Types
using	ObjectPtr = std::unique_ptr<AstObject, Deleter>
	unique pointer holding an AST raw pointer

Public Member Functions
	Frame (int naxes, std::string const &options="")
	Construct a Frame.
virtual	~Frame ()
	Frame (Frame const &)=default
	Copy constructor: make a deep copy.
	Frame (Frame &&)=default
Frame &	operator= (Frame const &)=delete
Frame &	operator= (Frame &&)=default
std::shared_ptr< Frame >	copy () const
	Return a deep copy of this object.
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.
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?
virtual void	setDomain (std::string const &domain)
	Set Domain: coordinate system domain.
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.
ParallelMap	under (Mapping const &next) const
	Return a parallel compound mapping 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.

Protected Member Functions
	Frame (AstFrame *rawPtr)
	Construct a Frame from a pointer to a raw AstFrame.
virtual std::shared_ptr< Object >	copyPolymorphic () const override
	Return a deep copy of this object.
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

Frame is used to represent a coordinate system.

It does this in rather the same way that a frame around a graph describes the coordinate space in which data are plotted. Consequently, a Frame has a Title (string) attribute, which describes the coordinate space, and contains axes which in turn hold information such as Label and Units strings which are used for labelling (e.g.) graphical output. In general, however, the number of axes is not restricted to two.

Functions are available for converting Frame coordinate values into a form suitable for display, and also for calculating distances and offsets between positions within the Frame.

Frames may also contain knowledge of how to transform to and from related coordinate systems.

Attributes

In addition to those provided by Mapping and Object, Frame provides the following attributes, where axis is an axis number, starting from 1 and (axis) may be omitted if the Frame has only one axis:

• ActiveUnit: pay attention to units when one Frame is used to match another? (Note: not a true attribute, but close).
• AlignSystem: Coordinate system used to align Frames
• Bottom(axis): Lowest axis value to display
• Digits/Digits(axis)`: Number of digits of precision
• Direction(axis): Display axis in conventional direction?
• Domain: Coordinate system domain
• Dut1: Difference between the UT1 and UTC timescale (sec)
• Epoch: Epoch of observation
• Format(axis): Format specification for axis values
• InternalUnit(axis): Physical units for unformated axis values
• Label(axis): Axis label
• MatchEnd: Match trailing axes?
• MaxAxes: Maximum number of axes a frame found by findFrame may have.
• MinAxes: Minimum number of axes a frame found by findFrame may have.
• NAxes: Number of Frame axes
• NormUnit(axis): Normalised physical units for formatted axis values
• ObsAlt: Geodetic altitude of observer (m)
• ObsLat: Geodetic latitude of observer
• ObsLon: Geodetic longitude of observer
• Permute: Allow axis permutation when used as a template?
• PreserveAxes: Preserve axes?
• Symbol(axis): Axis symbol
• System: Coordinate system used to describe positions within the domain
• Title: Frame title
• Top(axis): Highest axis value to display
• Unit(axis): Physical units for formatted axis values

Definition at line 157 of file Frame.h.

Member Typedef Documentation

ObjectPtr

using ast::Object::ObjectPtr = std::unique_ptr<AstObject, Deleter>

inherited

unique pointer holding an AST raw pointer

Definition at line 59 of file Object.h.

Constructor & Destructor Documentation

Frame() [1/4]

ast::Frame::Frame ( int naxes, std::string const & options = "" )

inlineexplicit

Construct a Frame.

Parameters

[in]	naxes	The number of Frame axes (i.e. the number of dimensions of the coordinate space which the Frame describes).
[in]	options	Comma-separated list of attribute assignments.

Definition at line 168 of file Frame.h.

            : Mapping(reinterpret_cast<AstMapping *>(astFrame(naxes, "%s", options.c_str()))) {
        assertOK();
    }

~Frame()

virtual ast::Frame::~Frame ( )

inlinevirtual

Definition at line 173 of file Frame.h.

{}

Frame() [2/4]

ast::Frame::Frame ( Frame const & )

default

Copy constructor: make a deep copy.

Frame() [3/4]

ast::Frame::Frame ( Frame && )

default

Frame() [4/4]

ast::Frame::Frame ( AstFrame * rawPtr )

inlineexplicitprotected

Construct a Frame from a pointer to a raw AstFrame.

This method is public so subclasses can call it.

Exceptions

std::invalid_argument

if rawPtr is not an AstFrame

TODO make protected and use friend class

Definition at line 1519 of file Frame.h.

                                     : Mapping(reinterpret_cast<AstMapping *>(rawPtr)) {
        if (!astIsAFrame(getRawPtr())) {
            std::ostringstream os;
            os << "This is a " << getClassName() << ", which is not a Frame";
            throw std::invalid_argument(os.str());
        }
    }

Member Function Documentation

angle()

double ast::Frame::angle ( PointD const & a, PointD const & b, PointD const & c ) const

inline

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, b or c have the wrong length

Definition at line 201 of file Frame.h.

                                                                          {
        assertPointLength(a, "a");
        assertPointLength(b, "b");
        assertPointLength(c, "c");
        return detail::safeDouble(astAngle(getRawPtr(), a.data(), b.data(), c.data()));
    }

applyForward() [1/3]

Array2D ast::Mapping::applyForward ( ConstArray2D const & from ) const

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.

                                                         {
        Array2D to = ndarray::allocate(getNOut(), from.getSize<1>());
        _tran(from, true, to);
        return to;
    }

applyForward() [2/3]

void ast::Mapping::applyForward ( ConstArray2D const & from, Array2D const & to ) const

inlineinherited

Perform a forward transformation on 2-D array, putting the results into a pre-allocated 2-D array.

Parameters

[in]	from	input coordinates, with dimensions (nPts, nIn)
[out]	to	transformed coordinates, with dimensions (nPts, nOut)

Definition at line 260 of file Mapping.h.

{ _tran(from, true, to); }

applyForward() [3/3]

std::vector< double > ast::Mapping::applyForward ( std::vector< double > const & from ) const

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.

                                                                        {
        auto fromArr = arrayFromVector(from, getNIn());
        std::vector<double> to(fromArr.getSize<1>() * getNOut());
        auto toArr = arrayFromVector(to, getNOut());
        _tran(fromArr, true, toArr);
        return to;
    }

applyInverse() [1/3]

Array2D ast::Mapping::applyInverse ( ConstArray2D const & from ) const

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)

Definition at line 302 of file Mapping.h.

                                                         {
        Array2D to = ndarray::allocate(getNIn(), from.getSize<1>());
        _tran(from, false, to);
        return to;
    }

applyInverse() [2/3]

void ast::Mapping::applyInverse ( ConstArray2D const & from, Array2D const & to ) const

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.

{ _tran(from, false, to); }

applyInverse() [3/3]

std::vector< double > ast::Mapping::applyInverse ( std::vector< double > const & from ) const

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.

                                                                        {
        auto fromArr = arrayFromVector(from, getNOut());
        std::vector<double> to(fromArr.getSize<1>() * getNIn());
        auto toArr = arrayFromVector(to, getNIn());
        _tran(fromArr, false, toArr);
        return to;
    }

axAngle()

double ast::Frame::axAngle ( PointD const & a, PointD const & b, int axis ) const

inline

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 a or b have the wrong length

Notes:

• The geodesic curve used by this function is the path of shortest distance between two points, as defined by the distance method.

Definition at line 229 of file Frame.h.

                                                                     {
        assertPointLength(a, "a");
        assertPointLength(b, "b");
        return detail::safeDouble(astAxAngle(getRawPtr(), a.data(), b.data(), axis));
    }

axDistance()

double ast::Frame::axDistance ( int axis, double v1, double v2 ) const

inline

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.

Definition at line 247 of file Frame.h.

                                                            {
        return detail::safeDouble(astAxDistance(getRawPtr(), axis, v1, v2));
    }

axOffset()

double ast::Frame::axOffset ( int axis, double v1, double dist ) const

inline

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

Definition at line 263 of file Frame.h.

                                                            {
        return detail::safeDouble(astAxOffset(getRawPtr(), axis, v1, dist));
    }

clear()

void ast::Object::clear ( std::string const & attrib )

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.

Definition at line 119 of file Object.h.

                                        {
        astClear(getRawPtr(), attrib.c_str());
        assertOK();
    }

convert()

std::shared_ptr< FrameSet > ast::Frame::convert	(	Frame const &	to,
		std::string const &	domainlist = "" )

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

• DSBSpecFrame

  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. If AlignSideBand is zero, the two DSBSpecFrames are aligned as if they were simple SpecFrames (i.e. the SideBand is ignored).

• Frame

  This function applies to all Frames. Alignment occurs within the coordinate system given by attribute AlignSystem.

• FrameSet

  If either this object or to is 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.

• SpecFrame

  Alignment occurs within the spectral system and standard of rest given by attributes AlignSystem and AlignStdOfRest.

• TimeFrame

  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.

                                                                                   {
    auto *rawFrameSet =
            reinterpret_cast<AstFrameSet *>(astConvert(getRawPtr(), to.getRawPtr(), domainlist.c_str()));
    assertOK(reinterpret_cast<AstObject *>(rawFrameSet));
    if (!rawFrameSet) {
        return std::shared_ptr<FrameSet>();
    }
    return Object::fromAstObject<FrameSet>(reinterpret_cast<AstObject *>(rawFrameSet), false);
}

copy()

std::shared_ptr< Frame > ast::Frame::copy ( ) const

inline

Return a deep copy of this object.

Definition at line 182 of file Frame.h.

{ return std::static_pointer_cast<Frame>(copyPolymorphic()); }

copyImpl()

template<typename T , typename AstT >

std::shared_ptr< T > ast::Object::copyImpl ( ) const

inlineprotectedinherited

Implementation of deep copy.

Should be called to implement copyPolymorphic by all derived classes.

Definition at line 320 of file Object.h.

                                      {
        auto *rawptr = reinterpret_cast<AstT *>(astCopy(getRawPtr()));
        auto retptr = std::shared_ptr<T>(new T(rawptr));
        assertOK();
        return retptr;
    }

copyPolymorphic()

virtual std::shared_ptr< Object > ast::Frame::copyPolymorphic ( ) const

inlineoverrideprotectedvirtual

Return a deep copy of this object.

This is called by copy.

Each subclass must override this method. The standard implementation is:

return copyImpl<astshim_class, ast_class>();

for example Frame implements this as:

return copyImpl<Frame, AstFrame>();

Reimplemented from ast::Mapping.

Reimplemented in ast::CmpFrame, ast::FrameDict, ast::FrameSet, ast::SkyFrame, ast::SpecFrame, and ast::TimeFrame.

Definition at line 1527 of file Frame.h.

{ return copyImpl<Frame, AstFrame>(); }

decompose()

template<typename Class >

template std::shared_ptr< Mapping > ast::Mapping::decompose ( int i, bool copy ) const

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[].

Template Parameters

Class

astshim class of returned object, typically Mapping or Frame.

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 i is not 0 or 1.
std::runtime_error	if this mapping is not a compound mapping.

Definition at line 64 of file Mapping.cc.

                                                              {
    if ((i < 0) || (i > 1)) {
        std::ostringstream os;
        os << "i =" << i << "; must be 0 or 1";
        throw std::invalid_argument(os.str());
    }
    // Report pre-existing problems now so our later test for "not a compound object" is accurate
    assertOK();
 
    AstMapping *rawMap1;
    AstMapping *rawMap2;
    int series, invert1, invert2;
    astDecompose(getRawPtr(), &rawMap1, &rawMap2, &series, &invert1, &invert2);
    assertOK();
 
    if (!rawMap2) {
        // Not a compound object; free rawMap1 (rawMap2 is null, so no need to free it) and throw an exception
        astAnnul(reinterpret_cast<AstObject *>(rawMap1));
        std::ostringstream os;
        os << "This " << getClassName() << " is not a compound object";
        throw std::runtime_error(os.str());
    }
 
    // Make a deep copy of the returned object and free the shallow copies
    AstMapping *retRawMap;
    int invert;
    if (i == 0) {
        retRawMap = reinterpret_cast<AstMapping *>(astCopy(reinterpret_cast<AstObject *>(rawMap1)));
        invert = invert1;
    } else {
        retRawMap = reinterpret_cast<AstMapping *>(astCopy(reinterpret_cast<AstObject *>(rawMap2)));
        invert = invert2;
    }
    astAnnul(reinterpret_cast<AstObject *>(rawMap1));
    astAnnul(reinterpret_cast<AstObject *>(rawMap2));
    assertOK();
 
    // If the mapping's internal invert flag does not match the value used when the CmpMap was made
    // then invert the mapping. Note that it is not possible to create such objects in astshim
    // but it is possible to read in objects created by other software.
    if (invert != astGetI(retRawMap, "Invert")) {
        astInvert(retRawMap);
        assertOK();
    }
 
    return Object::fromAstObject<Class>(reinterpret_cast<AstObject *>(retRawMap), copy);
}

distance()

double ast::Frame::distance ( PointD const & point1, PointD const & point2 ) const

inline

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.

                                                                      {
        assertPointLength(point1, "point1");
        assertPointLength(point2, "point2");
        return detail::safeDouble(astDistance(getRawPtr(), point1.data(), point2.data()));
    }

findFrame()

std::shared_ptr< FrameSet > ast::Frame::findFrame	(	Frame const &	tmplt,
		std::string const &	domainlist = "" )

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

• FrameSet

  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 Equinox value for the coordinate system has not been specified, so will be obtained from the target. If the target is a FrameSet, its Current attribute 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 tmpl argument 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 Domain attribute 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.

                                                                                        {
    auto *rawFrameSet =
            reinterpret_cast<AstFrameSet *>(astFindFrame(getRawPtr(), tmplt.getRawPtr(), domainlist.c_str()));
    assertOK(reinterpret_cast<AstObject *>(rawFrameSet));
    if (!rawFrameSet) {
        return std::shared_ptr<FrameSet>();
    }
    return Object::fromAstObject<FrameSet>(reinterpret_cast<AstObject *>(rawFrameSet), false);
}

format()

std::string ast::Frame::format ( int axis, double value ) const

inline

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.

Definition at line 782 of file Frame.h.

                                                   {
        char const *rawstr = astFormat(getRawPtr(), axis, value);
        assertOK();
        return std::string(rawstr);
    }

fromAstObject()

template<typename Class >

template std::shared_ptr< Object > ast::Object::fromAstObject< Object > ( AstObject * rawObj, bool copy )

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.

                                                                       {
    AstObject *rawObjCopy = rawObj;
    if (copy) {
        rawObjCopy = reinterpret_cast<AstObject *>(astCopy(rawObj));
        astAnnul(rawObj);
    }
    assertOK(rawObjCopy);
 
    // Make the appropriate ast shim object and dynamically cast to the desired output type
    auto retObjectBeforeCast = Object::_basicFromAstObject(rawObjCopy);
    auto retObject = std::dynamic_pointer_cast<Class>(retObjectBeforeCast);
    if (!retObject) {
        std::ostringstream os;
        os << "The component is of type " << retObject->getClassName()
           << ", which could not be cast to the desired type " << typeid(Class).name();
        throw std::runtime_error(os.str());
    }
    return retObject;
}

fromString()

static std::shared_ptr< Object > ast::Object::fromString ( std::string const & str )

inlinestaticinherited

Construct an Object from a string, using astFromString.

Definition at line 88 of file Object.h.

                                                                  {
        auto *rawPtr = reinterpret_cast<AstObject *>(astFromString(str.c_str()));
        assertOK(rawPtr);
        return Object::_basicFromAstObject(rawPtr);
    }

getActiveUnit()

bool ast::Frame::getActiveUnit ( ) const

inline

Get ActiveUnit: pay attention to units when one Frame is used to match another?

Definition at line 792 of file Frame.h.

                               {
        bool ret = astGetActiveUnit(getRawPtr());
        assertOK();
        return ret;
    }

getAlignSystem()

std::string ast::Frame::getAlignSystem ( ) const

inline

Get AlignSystem: the coordinate system used by convert and findFrame to align Frames.

Definition at line 802 of file Frame.h.

{ return getC("AlignSystem"); }

getB()

bool ast::Object::getB ( std::string const & attrib ) const

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

Definition at line 348 of file Object.h.

                                             {
        bool val = astGetI(getRawPtr(), attrib.c_str());
        assertOK();
        return val;
    }

getBottom()

double ast::Frame::getBottom ( int axis ) const

inline

Get Bottom for one axis: the lowest axis value to display.

Definition at line 807 of file Frame.h.

{ return getD(detail::formatAxisAttr("Bottom", axis)); }

getC()

std::string const ast::Object::getC ( std::string const & attrib ) const

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

Definition at line 361 of file Object.h.

                                                        {
        char const *rawval = astGetC(getRawPtr(), attrib.c_str());
        assertOK();
        return std::string(rawval);
    }

getClassName()

std::string ast::Object::getClassName ( ) const

inlineinherited

Get Class: the name of the class (e.g.

ZoomMap)

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.

{ return detail::getClassName(getRawPtr()); }

getD()

double ast::Object::getD ( std::string const & attrib ) const

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

Definition at line 374 of file Object.h.

                                               {
        double val = astGetD(getRawPtr(), attrib.c_str());
        assertOK();
        return val;
    }

getDigits() [1/2]

int ast::Frame::getDigits ( ) const

inline

Get Digits: the default used if no specific value specified for an axis.

Definition at line 812 of file Frame.h.

{ return getI("Digits"); }

getDigits() [2/2]

int ast::Frame::getDigits ( int axis ) const

inline

Get Digits for one axis.

Definition at line 817 of file Frame.h.

{ return getI(detail::formatAxisAttr("Digits", axis)); }

getDirection()

bool ast::Frame::getDirection ( int axis ) const

inline

Get Direction for one axis: display axis in conventional direction?

Definition at line 822 of file Frame.h.

{ return getB(detail::formatAxisAttr("Direction", axis)); }

getDomain()

std::string ast::Frame::getDomain ( ) const

inline

Get Domain: coordinate system domain.

Definition at line 827 of file Frame.h.

{ return getC("Domain"); }

getDut1()

double ast::Frame::getDut1 ( ) const

inline

Get Dut1: difference between the UT1 and UTC timescale (sec)

Definition at line 832 of file Frame.h.

{ return getD("Dut1"); }

getEpoch()

double ast::Frame::getEpoch ( ) const

inline

Get Epoch: Epoch of observation.

Definition at line 837 of file Frame.h.

{ return getD("Epoch"); }

getF()

float ast::Object::getF ( std::string const & attrib ) const

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

Definition at line 387 of file Object.h.

                                              {
        float val = astGetF(getRawPtr(), attrib.c_str());
        assertOK();
        return val;
    }

getFormat()

std::string ast::Frame::getFormat ( int axis ) const

inline

Get Format for one axis: format specification for axis values.

Definition at line 842 of file Frame.h.

{ return getC(detail::formatAxisAttr("Format", axis)); }

getI()

int ast::Object::getI ( std::string const & attrib ) const

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

Definition at line 178 of file Object.cc.

                                              {
    int val = astGetI(getRawPtr(), attrib.c_str());
    assertOK();
    return val;
}

getID()

std::string ast::Object::getID ( ) const

inlineinherited

Get ID: object identification string that is not copied.

Definition at line 142 of file Object.h.

{ return getC("ID"); }

getIdent()

std::string ast::Object::getIdent ( ) const

inlineinherited

Get Ident: object identification string that is copied.

Definition at line 145 of file Object.h.

{ return getC("Ident"); }

getInternalUnit()

std::string ast::Frame::getInternalUnit ( int axis ) const

inline

Get InternalUnit(axis) read-only attribute for one axis: physical units for unformated axis values.

Definition at line 848 of file Frame.h.

{ return getC(detail::formatAxisAttr("InternalUnit", axis)); }

getIsLinear()

bool ast::Mapping::getIsLinear ( ) const

inlineinherited

Get IsLinear: is the Mapping linear?

Definition at line 100 of file Mapping.h.

{ return getB("IsLinear"); }

getIsSimple()

bool ast::Mapping::getIsSimple ( ) const

inlineinherited

Get IsSimple: has the mapping been simplified?

Definition at line 87 of file Mapping.h.

{ return getI("IsSimple"); }

getL()

long int ast::Object::getL ( std::string const & attrib ) const

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

Definition at line 409 of file Object.h.

                                                 {
        long int val = astGetL(getRawPtr(), attrib.c_str());
        assertOK();
        return val;
    }

getLabel()

std::string ast::Frame::getLabel ( int axis ) const

inline

Get Label(axis) for one axis: axis label.

Definition at line 853 of file Frame.h.

{ return getC(detail::formatAxisAttr("Label", axis)); }

getMatchEnd()

bool ast::Frame::getMatchEnd ( ) const

inline

Get MatchEnd: match trailing axes?

Definition at line 858 of file Frame.h.

{ return getB("MatchEnd"); }

getMaxAxes()

int ast::Frame::getMaxAxes ( ) const

inline

Get MaxAxes: the maximum axes a frame found by findFrame may have.

Definition at line 864 of file Frame.h.

{ return getI("MaxAxes"); }

getMinAxes()

int ast::Frame::getMinAxes ( ) const

inline

Get MinAxes: the maximum axes a frame found by findFrame may have.

Definition at line 870 of file Frame.h.

{ return getI("MinAxes"); }

getNAxes()

int ast::Frame::getNAxes ( ) const

inline

Get NAxes: the number of axes in the frame (i.e.

the number of dimensions of the coordinate space which the Frame describes).

Definition at line 876 of file Frame.h.

{ return getI("NAxes"); }

getNIn()

int ast::Mapping::getNIn ( ) const

inlineinherited

Get NIn: the number of input axes.

Definition at line 77 of file Mapping.h.

{ return getI("NIn"); }

getNObject()

int ast::Object::getNObject ( ) const

inlineinherited

Get NObject: number of AST objects in existence of the same type as the underlying AST class.

Warning

Intended only for debugging astshim.

Definition at line 153 of file Object.h.

{ return getI("NObject"); }

getNormUnit()

std::string ast::Frame::getNormUnit ( int axis ) const

inline

Get NormUnit(axis) read-only attribute for one frame: normalised physical units for formatted axis values.

Definition at line 882 of file Frame.h.

{ return getC(detail::formatAxisAttr("NormUnit", axis)); }

getNOut()

int ast::Mapping::getNOut ( ) const

inlineinherited

Get NOut: the number of output axes.

Definition at line 82 of file Mapping.h.

{ return getI("NOut"); }

getObjSize()

int ast::Object::getObjSize ( ) const

inlineinherited

Get ObjSize: the in-memory size of the AST object in bytes.

Definition at line 156 of file Object.h.

{ return getI("ObjSize"); }

getObsAlt()

double ast::Frame::getObsAlt ( ) const

inline

Get ObsAlt: Geodetic altitude of observer (m).

Definition at line 887 of file Frame.h.

{ return getD("ObsAlt"); }

getObsLat()

std::string ast::Frame::getObsLat ( ) const

inline

Get ObsLat: Geodetic latitude of observer.

Definition at line 892 of file Frame.h.

{ return getC("ObsLat"); }

getObsLon()

std::string ast::Frame::getObsLon ( ) const

inline

Get ObsLon: Geodetic longitude of observer.

Definition at line 897 of file Frame.h.

{ return getC("ObsLon"); }

getPermute()

bool ast::Frame::getPermute ( ) const

inline

Get Permute: allow axis permutation when used as a template?

Definition at line 902 of file Frame.h.

{ return getB("Permute"); }

getPreserveAxes()

bool ast::Frame::getPreserveAxes ( ) const

inline

Get PreserveAxes: preserve axes?

Definition at line 907 of file Frame.h.

{ return getB("PreserveAxes"); }

getRawPtr() [1/2]

AstObject * ast::Object::getRawPtr ( )

inlineinherited

Get the raw AST pointer.

Intended for internal use only, but cannot be made protected without endless "friend class" declarations.

Definition at line 294 of file Object.h.

{ return &*_objPtr; };

getRawPtr() [2/2]

AstObject const * ast::Object::getRawPtr ( ) const

inlineinherited

Get the raw AST pointer.

Intended for internal use only, but cannot be made protected without endless "friend class" declarations.

Definition at line 292 of file Object.h.

{ return &*_objPtr; };

getRefCount()

int ast::Object::getRefCount ( ) const

inlineinherited

Get RefCount: number of active pointers to the underlying AST object.

Warning

Intended only for debugging astshim.

Definition at line 163 of file Object.h.

{ return getI("RefCount"); }

getReport()

bool ast::Mapping::getReport ( ) const

inlineinherited

Get Report: report transformed coordinates to stdout?

Definition at line 105 of file Mapping.h.

{ return getB("Report"); }

getSymbol()

std::string ast::Frame::getSymbol ( int axis ) const

inline

Get Symbol(axis) for one axis: axis symbol.

Definition at line 912 of file Frame.h.

{ return getC(detail::formatAxisAttr("Symbol", axis)); }

getSystem()

std::string ast::Frame::getSystem ( ) const

inline

Get System: coordinate system used to describe positions within the domain.

Definition at line 918 of file Frame.h.

{ return getC("System"); }

getTitle()

std::string ast::Frame::getTitle ( ) const

inline

Get Title: frame title.

Definition at line 923 of file Frame.h.

{ return getC("Title"); }

getTop()

double ast::Frame::getTop ( int axis ) const

inline

Get Top: the highest axis value to display.

Definition at line 928 of file Frame.h.

{ return getD(detail::formatAxisAttr("Top", axis)); }

getUnit()

std::string ast::Frame::getUnit ( int axis ) const

inline

Get Unit(axis) for one axis: physical units for formatted axis values.

Definition at line 933 of file Frame.h.

{ return getC(detail::formatAxisAttr("Unit", axis)); }

getUseDefs()

bool ast::Object::getUseDefs ( ) const

inlineinherited

Get UseDefs: allow use of default values for Object attributes?

Definition at line 166 of file Object.h.

{ return getB("UseDefs"); }

hasAttribute()

bool ast::Object::hasAttribute ( std::string const & attrib ) const

inlineinherited

Does this object have an attribute with the specified name?

Definition at line 127 of file Object.h.

                                                     {
        bool ret = astHasAttribute(getRawPtr(), attrib.c_str());
        assertOK();
        return ret;
    }

hasForward()

bool ast::Mapping::hasForward ( ) const

inlineinherited

Is the forward transform available?

Note

This gets the TranForward attribute, but is named hasForward instead of getTranForward for clarity, since it does not return a transform.

Definition at line 114 of file Mapping.h.

{ return getB("TranForward"); }

hasInverse()

bool ast::Mapping::hasInverse ( ) const

inlineinherited

Is the inverse transform available?

Note

This gets the TranInverse attribute, but is named hasInverse instead of getTranInverse for clarity, since it does not return a transform.

Definition at line 123 of file Mapping.h.

{ return getB("TranInverse"); }

intersect()

std::vector< double > ast::Frame::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.

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 nan coordinate 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.

                                                                                                     {
    int const naxes = 2;
    detail::assertEqual(getNAxes(), "# axes", naxes, "");
    detail::assertEqual(a1.size(), "a1.size()", static_cast<std::size_t>(naxes), "");
    detail::assertEqual(a2.size(), "a2.size()", static_cast<std::size_t>(naxes), "");
    detail::assertEqual(b1.size(), "b1.size()", static_cast<std::size_t>(naxes), "");
    detail::assertEqual(b2.size(), "b2.size()", static_cast<std::size_t>(naxes), "");
    std::vector<double> ret(naxes);
    astIntersect(getRawPtr(), a1.data(), a2.data(), b1.data(), b2.data(), ret.data());
    assertOK();
    detail::astBadToNan(ret);
    return ret;
}

inverted()

std::shared_ptr< Mapping > ast::Mapping::inverted ( ) const

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.

                                               {
    auto rawCopy = reinterpret_cast<AstMapping *>(astCopy(getRawPtr()));
    astInvert(rawCopy);
    assertOK(reinterpret_cast<AstObject *>(rawCopy));
    // use false because the pointer has already been copied
    return Object::fromAstObject<Mapping>(reinterpret_cast<AstObject *>(rawCopy), false);
}

isInverted()

bool ast::Mapping::isInverted ( ) const

inlineinherited

Is this an inverted mapping?

Note: this gets the Invert attribute. This method is not called getInvert because that sounds like it might return the inverse.

Definition at line 95 of file Mapping.h.

{ return getB("Invert"); }

linearApprox()

Array2D ast::Mapping::linearApprox ( PointD const & lbnd, PointD const & ubnd, double tol ) const

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.

                                                                                      {
    int const nIn = getNIn();
    int const nOut = getNOut();
    detail::assertEqual(lbnd.size(), "lbnd.size", static_cast<std::size_t>(nIn), "nIn");
    detail::assertEqual(ubnd.size(), "ubnd.size", static_cast<std::size_t>(nIn), "nIn");
    Array2D fit = ndarray::allocate(ndarray::makeVector(1 + nIn, nOut));
    int isOK = astLinearApprox(getRawPtr(), lbnd.data(), ubnd.data(), tol, fit.getData());
    assertOK();
    if (!isOK) {
        throw std::runtime_error("Mapping not sufficiently linear");
    }
    return fit;
}

lock()

void ast::Object::lock ( bool wait )

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).

Definition at line 202 of file Object.h.

                         {
        astLock(getRawPtr(), static_cast<int>(wait));
        assertOK();
    }

makeShim()

template<typename ShimT , typename AstT >

static std::shared_ptr< ShimT > ast::Object::makeShim ( AstObject * p )

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

Definition at line 310 of file Object.h.

                                                       {
        return std::shared_ptr<ShimT>(new ShimT(reinterpret_cast<AstT *>(p)));
    }

matchAxes()

std::vector< int > ast::Frame::matchAxes ( Frame const & other ) const

inline

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 in other that has no corresponding axis in this frame. The number of elements in the array will be the number of axes in other.

Notes

• Corresponding axes are identified by the fact that a Mapping can be found between them using findFrame or convert. Thus, "corresponding axes" are not necessarily identical. For instance, SkyFrame axes will match even if they describe different celestial coordinate systems.

Definition at line 985 of file Frame.h.

                                                       {
        std::vector<int> ret(other.getNIn());
        astMatchAxes(getRawPtr(), other.getRawPtr(), ret.data());
        assertOK();
        return ret;
    }

norm()

PointD ast::Frame::norm ( PointD value ) const

inline

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 of value lie outside the expected range for the Frame, the corresponding returned value is changed to a acceptable (normalised) value. Otherwise, the axes of value are 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 norm function 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).

Definition at line 1045 of file Frame.h.

                                    {
        astNorm(getRawPtr(), value.data());
        assertOK();
        detail::astBadToNan(value);
        return value;
    }

offset()

PointD ast::Frame::offset ( PointD point1, PointD point2, double offset ) const

inline

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 distance function.

Exceptions

std::invalid_argument

if: point1 or point2 is the wrong length

Definition at line 1075 of file Frame.h.

                                                                     {
        assertPointLength(point1, "point1");
        assertPointLength(point2, "point2");
        PointD ret(getNIn());
        astOffset(getRawPtr(), point1.data(), point2.data(), offset, ret.data());
        assertOK();
        detail::astBadToNan(ret);
        return ret;
    }

offset2()

DirectionPoint ast::Frame::offset2 ( PointD const & point1, double angle, double offset ) const

inline

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__BAD values

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.

                                                                                    {
        detail::assertEqual(getNIn(), "naxes", 2, " cannot call offset2");
        assertPointLength(point1, "point1");
        PointD point2(getNIn());
        double offsetAngle = astOffset2(getRawPtr(), point1.data(), angle, offset, point2.data());
        assertOK();
        detail::astBadToNan(point2);
        return DirectionPoint(detail::safeDouble(offsetAngle), point2);
    }

operator!=()

bool ast::Object::operator!= ( Object const & rhs ) const

inlineinherited

Return True if this and rhs are not equal.

See operator== for details

Definition at line 82 of file Object.h.

                                             {
        return !(*this == rhs); };

operator=() [1/2]

Frame & ast::Frame::operator= ( Frame && )

default

operator=() [2/2]

Frame & ast::Frame::operator= ( Frame const & )

delete

operator==()

bool ast::Object::operator== ( Object const & rhs ) const

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.

                                               {
    auto thisStr = this->show(false);
    auto rhsStr = rhs.show(false);
    return rhsStr == thisStr;
}

permAxes()

void ast::Frame::permAxes ( std::vector< int > perm )

inline

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.

                                       {
        detail::assertEqual(perm.size(), "perm.size()", static_cast<std::size_t>(getNAxes()), "naxes");
        astPermAxes(getRawPtr(), perm.data());
        assertOK();
    }

pickAxes()

FrameMapping ast::Frame::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.

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:

• The new frame.
• A mapping (usually a PermMap, but may be a UnitMap) that describes the axis permutation that has taken place between the original and new Frames. The Mapping's forward transformation will convert coordinates from the original Frame into the new one, and vice versa.

Definition at line 68 of file Frame.cc.

                                                             {
    AstMapping *rawMap;
    auto *rawFrame =
            reinterpret_cast<AstFrame *>(astPickAxes(getRawPtr(), axes.size(), axes.data(), &rawMap));
    assertOK(reinterpret_cast<AstObject *>(rawFrame), reinterpret_cast<AstObject *>(rawMap));
    std::shared_ptr<Frame> frame;
    try {
        frame = Object::fromAstObject<Frame>(reinterpret_cast<AstObject *>(rawFrame), false);
    } catch (...) {
        astAnnul(rawMap);
        throw;
    }
    auto map = Object::fromAstObject<Mapping>(reinterpret_cast<AstObject *>(rawMap), false);
    return FrameMapping(frame, map);
}

rate()

double ast::Mapping::rate ( PointD const & at, int ax1, int ax2 ) const

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 ax1 with respect to input ax2, evaluated at at, or nan if the value cannot be calculated.

Definition at line 215 of file Mapping.h.

                                                          {
        detail::assertEqual(at.size(), "at.size", static_cast<std::size_t>(getNIn()), "nIn");
        double result = astRate(getRawPtr(), const_cast<double *>(at.data()), ax1, ax2);
        assertOK();
        return result;
    }

resolve()

ResolvedPoint ast::Frame::resolve	(	std::vector< double > const &	point1,
		std::vector< double > const &	point2,
		std::vector< double > const &	point3 ) const

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 nan coordinate values if any of the input coordinates are invalid, or if the required output values are undefined.

Definition at line 84 of file Frame.cc.

                                                                    {
    int const naxes = getNAxes();
    detail::assertEqual(point1.size(), "a1.size()", static_cast<std::size_t>(naxes), "");
    detail::assertEqual(point2.size(), "a2.size()", static_cast<std::size_t>(naxes), "");
    detail::assertEqual(point3.size(), "b1.size()", static_cast<std::size_t>(naxes), "");
    ResolvedPoint ret(naxes);
    astResolve(getRawPtr(), point1.data(), point2.data(), point3.data(), ret.point.data(), &ret.d1, &ret.d2);
    assertOK();
    detail::astBadToNan(ret.point);
    return ret;
}

same()

bool ast::Object::same ( Object const & other ) const

inlineinherited

Does this contain the same AST object as another?

This is a test of identity, not of equality.

Definition at line 212 of file Object.h.

{ return astSame(getRawPtr(), other.getRawPtr()); }

set()

void ast::Object::set ( std::string const & setting )

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

Definition at line 436 of file Object.h.

                                       {
        astSet(getRawPtr(), "%s", setting.c_str());
        assertOK();
    }

setActiveUnit()

void ast::Frame::setActiveUnit ( bool enable )

inline

Set ActiveUnit: pay attention to units when one Frame is used to match another?

Definition at line 1295 of file Frame.h.

                                    {
        astSetActiveUnit(getRawPtr(), enable);
        assertOK();
    }

setAlignSystem()

void ast::Frame::setAlignSystem ( std::string const & system )

inline

Set AlignSystem: the coordinate system used by convert and findFrame to align Frames.

Definition at line 1203 of file Frame.h.

{ setC("AlignSystem", system); }

setB()

void ast::Object::setB ( std::string const & attrib, bool value )

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

Definition at line 448 of file Object.h.

                                                   {
        astSetI(getRawPtr(), attrib.c_str(), value);
        assertOK();
    }

setBottom()

void ast::Frame::setBottom ( int axis, double bottom )

inline

Set Bottom: the lowest axis value to display.

Definition at line 1208 of file Frame.h.

{ setD(detail::formatAxisAttr("Bottom", axis), bottom); }

setC()

void ast::Object::setC ( std::string const & attrib, std::string const & value )

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

Definition at line 460 of file Object.h.

                                                               {
        astSetC(getRawPtr(), attrib.c_str(), value.c_str());
        assertOK();
    }

setD()

void ast::Object::setD ( std::string const & attrib, double value )

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

Definition at line 472 of file Object.h.

                                                     {
        astSetD(getRawPtr(), attrib.c_str(), value);
        assertOK();
    }

setDigits() [1/2]

void ast::Frame::setDigits ( int axis, int digits )

inline

Set Digits for one axis: number of digits of precision.

Definition at line 1218 of file Frame.h.

{ setD(detail::formatAxisAttr("Digits", axis), digits); }

setDigits() [2/2]

void ast::Frame::setDigits ( int digits )

inline

Set Digits for all axes: number of digits of precision.

Definition at line 1213 of file Frame.h.

{ setI("Digits", digits); }

setDirection()

void ast::Frame::setDirection ( bool direction, int axis )

inline

Set Direction for one axis: display axis in conventional direction?

Definition at line 1223 of file Frame.h.

                                                {
        setB(detail::formatAxisAttr("Direction", axis), direction);
    }

setDomain()

virtual void ast::Frame::setDomain ( std::string const & domain )

inlinevirtual

Set Domain: coordinate system domain.

Reimplemented in ast::FrameDict.

Definition at line 1230 of file Frame.h.

{ setC("Domain", domain); }

setDut1()

void ast::Frame::setDut1 ( double dut1 )

inline

Set Dut1: difference between the UT1 and UTC timescale (sec)

Definition at line 1235 of file Frame.h.

{ setD("Dut1", dut1); }

setEpoch() [1/2]

void ast::Frame::setEpoch ( double epoch )

inline

Set Epoch: Epoch of observation as a double (years)

Definition at line 1240 of file Frame.h.

{ setD("Epoch", epoch); }

setEpoch() [2/2]

void ast::Frame::setEpoch ( std::string const & epoch )

inline

Set Epoch: Epoch of observation as a string.

Definition at line 1245 of file Frame.h.

{ setC("Epoch", epoch); }

setF()

void ast::Object::setF ( std::string const & attrib, float value )

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

Definition at line 484 of file Object.h.

                                                    {
        astSetF(getRawPtr(), attrib.c_str(), value);
        assertOK();
    }

setFormat()

void ast::Frame::setFormat ( int axis, std::string const & format )

inline

Set Format for one axis: format specification for axis values.

Definition at line 1250 of file Frame.h.

                                                      {
        setC(detail::formatAxisAttr("Format", axis), format);
    }

setI()

void ast::Object::setI ( std::string const & attrib, int value )

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

Definition at line 496 of file Object.h.

                                                  {
        astSetI(getRawPtr(), attrib.c_str(), value);
        assertOK();
    }

setID()

void ast::Object::setID ( std::string const & id )

inlineinherited

Set ID: object identification string that is not copied.

Definition at line 215 of file Object.h.

{ setC("ID", id); }

setIdent()

void ast::Object::setIdent ( std::string const & ident )

inlineinherited

Set Ident: object identification string that is copied.

Definition at line 218 of file Object.h.

{ setC("Ident", ident); }

setL()

void ast::Object::setL ( std::string const & attrib, long int value )

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

Definition at line 508 of file Object.h.

                                                       {
        astSetL(getRawPtr(), attrib.c_str(), value);
        assertOK();
    }

setLabel()

void ast::Frame::setLabel ( int axis, std::string const & label )

inline

Set Label(axis) for one axis: axis label.

Definition at line 1257 of file Frame.h.

{ setC(detail::formatAxisAttr("Label", axis), label); }

setMatchEnd()

void ast::Frame::setMatchEnd ( bool match )

inline

Set MatchEnd: match trailing axes?

Definition at line 1262 of file Frame.h.

{ setB("MatchEnd", match); }

setMaxAxes()

void ast::Frame::setMaxAxes ( int maxAxes )

inline

Get MaxAxes: the maximum number of axes a frame found by findFrame may have.

Definition at line 1268 of file Frame.h.

{ setI("MaxAxes", maxAxes); }

setMinAxes()

void ast::Frame::setMinAxes ( int minAxes )

inline

Get MinAxes: the minimum number of axes a frame found by findFrame may have.

Definition at line 1274 of file Frame.h.

{ setI("MinAxes", minAxes); }

setObsAlt()

void ast::Frame::setObsAlt ( double alt )

inline

Set ObsAlt: Geodetic altitude of observer (m).

Definition at line 1279 of file Frame.h.

{ setD("ObsAlt", alt); }

setObsLat()

void ast::Frame::setObsLat ( std::string const & lat )

inline

Set ObsLat: frame title.

Definition at line 1284 of file Frame.h.

{ setC("ObsLat", lat); }

setObsLon()

void ast::Frame::setObsLon ( std::string const & lon )

inline

Set ObsLon: Geodetic longitude of observer.

Definition at line 1289 of file Frame.h.

{ setC("ObsLon", lon); }

setPermute()

void ast::Frame::setPermute ( bool permute )

inline

Set Permute: allow axis permutation when used as a template?

Definition at line 1303 of file Frame.h.

{ setB("Permute", permute); }

setPreserveAxes()

void ast::Frame::setPreserveAxes ( bool preserve )

inline

Set PreserveAxes: preserve axes?

Definition at line 1308 of file Frame.h.

{ setB("PreserveAxes", preserve); }

setReport()

void ast::Mapping::setReport ( bool report )

inlineinherited

Set Report: report transformed coordinates to stdout?

Definition at line 225 of file Mapping.h.

{ setB("Report", report); }

setSymbol()

void ast::Frame::setSymbol ( int axis, std::string const & symbol )

inline

Set Symbol(axis) for one axis: axis symbol.

Definition at line 1313 of file Frame.h.

                                                      {
        setC(detail::formatAxisAttr("Symbol", axis), symbol);
    }

setSystem()

void ast::Frame::setSystem ( std::string const & system )

inline

Set System: coordinate system used to describe positions within the domain.

Definition at line 1321 of file Frame.h.

{ setC("System", system); }

setTitle()

void ast::Frame::setTitle ( std::string const & title )

inline

Set Title: frame title.

Definition at line 1326 of file Frame.h.

{ setC("Title", title); }

setTop()

void ast::Frame::setTop ( int axis, double top )

inline

Set Top for one axis: the highest axis value to display.

Definition at line 1331 of file Frame.h.

{ setD(detail::formatAxisAttr("Top", axis), top); }

setUnit()

void ast::Frame::setUnit ( int axis, std::string const & unit )

inline

Set Unit(axis) for one axis: physical units for formatted axis values.

Definition at line 1336 of file Frame.h.

{ setC(detail::formatAxisAttr("Unit", axis), unit); }

setUseDefs()

void ast::Object::setUseDefs ( bool usedefs )

inlineinherited

Set UseDefs: allow use of default values for Object attributes?

Definition at line 221 of file Object.h.

{ setB("UseDefs", usedefs); }

show() [1/2]

std::string ast::Object::show ( bool showComments = true ) const

inherited

Return a textual description the object as a string.

Parameters

[in]

showComments

Show comments?

Definition at line 165 of file Object.cc.

                                              {
    std::ostringstream os;
    show(os, showComments);
    return os.str();
}

show() [2/2]

void ast::Object::show ( std::ostream & os, bool showComments = true ) const

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.

                                                         {
    Stream stream(nullptr, &os);
    Channel ch(stream, showComments ? "" : "Comment=0");
    ch.write(*this);
    assertOK();
}

simplified()

std::shared_ptr< Mapping > ast::Mapping::simplified ( ) const

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.

Definition at line 248 of file Mapping.h.

                                              {
        AstObject *rawSimpMap = reinterpret_cast<AstObject *>(astSimplify(getRawPtr()));
        assertOK(rawSimpMap);
        return Object::fromAstObject<Mapping>(rawSimpMap, true);
    }

test()

bool ast::Object::test ( std::string const & attrib ) const

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.

Definition at line 250 of file Object.h.

                                             {
        bool res = astTest(getRawPtr(), attrib.c_str());
        assertOK();
        return res;
    }

then()

SeriesMap ast::Mapping::then ( Mapping const & next ) const

inherited

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 next does 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.

{ return SeriesMap(*this, next); }

tranGridForward() [1/2]

void ast::Mapping::tranGridForward ( PointI const & lbnd, PointI const & ubnd, double tol, int maxpix, Array2D const & to ) const

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.

                                                  {
        _tranGrid(lbnd, ubnd, tol, maxpix, true, to);
    }

tranGridForward() [2/2]

Array2D ast::Mapping::tranGridForward ( PointI const & lbnd, PointI const & ubnd, double tol, int maxpix, int nPts ) const

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

Definition at line 369 of file Mapping.h.

                                                                                                            {
        Array2D to = ndarray::allocate(nPts, getNOut());
        _tranGrid(lbnd, ubnd, tol, maxpix, true, to);
        return to;
    }

tranGridInverse() [1/2]

void ast::Mapping::tranGridInverse ( PointI const & lbnd, PointI const & ubnd, double tol, int maxpix, Array2D const & to ) const

inlineinherited

Transform a grid of points in the inverse direction.

See tranGridForward for the arguments, swapping nIn and nOut

Definition at line 380 of file Mapping.h.

                                                  {
        _tranGrid(lbnd, ubnd, tol, maxpix, false, to);
    }

tranGridInverse() [2/2]

Array2D ast::Mapping::tranGridInverse ( PointI const & lbnd, PointI const & ubnd, double tol, int maxpix, int nPts ) const

inlineinherited

Transform a grid of points in the inverse direction.

See tranGridForward for the arguments, swapping nIn and nOut

Definition at line 390 of file Mapping.h.

                                                                                                            {
        Array2D to = ndarray::allocate(nPts, getNIn());
        _tranGrid(lbnd, ubnd, tol, maxpix, false, to);
        return to;
    }

under() [1/2]

CmpFrame ast::Frame::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.

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.

{ return CmpFrame(*this, next); }

under() [2/2]

ParallelMap ast::Mapping::under ( Mapping const & next ) const

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 final next.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.

{ return ParallelMap(*this, next); }

unformat()

NReadValue ast::Frame::unformat ( int axis, std::string const & str ) const

inline

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:

• 99
• 1.25
• -1.6
• 1E8
• -.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)&mdash;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.

Definition at line 1502 of file Frame.h.

                                                              {
        double value;
        int nread = astUnformat(getRawPtr(), axis, str.c_str(), &value);
        assertOK();
        return NReadValue(nread, detail::safeDouble(value));
    }

unlock()

void ast::Object::unlock ( bool report = false )

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).

Definition at line 280 of file Object.h.

                                     {
        astUnlock(getRawPtr(), static_cast<int>(report));
        assertOK();
    }

Friends And Related Symbol Documentation

Object

friend class Object

friend

Definition at line 158 of file Frame.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+6e55a43351/include/astshim/Frame.h
• /j/snowflake/release/lsstsw/stack/lsst-scipipe-9.0.0/Linux64/astshim/g3156d2b45e+6e55a43351/src/Frame.cc