LSST Applications  21.0.0-172-gfb10e10a+18fedfabac,22.0.0+297cba6710,22.0.0+80564b0ff1,22.0.0+8d77f4f51a,22.0.0+a28f4c53b1,22.0.0+dcf3732eb2,22.0.1-1-g7d6de66+2a20fdde0d,22.0.1-1-g8e32f31+297cba6710,22.0.1-1-geca5380+7fa3b7d9b6,22.0.1-12-g44dc1dc+2a20fdde0d,22.0.1-15-g6a90155+515f58c32b,22.0.1-16-g9282f48+790f5f2caa,22.0.1-2-g92698f7+dcf3732eb2,22.0.1-2-ga9b0f51+7fa3b7d9b6,22.0.1-2-gd1925c9+bf4f0e694f,22.0.1-24-g1ad7a390+a9625a72a8,22.0.1-25-g5bf6245+3ad8ecd50b,22.0.1-25-gb120d7b+8b5510f75f,22.0.1-27-g97737f7+2a20fdde0d,22.0.1-32-gf62ce7b1+aa4237961e,22.0.1-4-g0b3f228+2a20fdde0d,22.0.1-4-g243d05b+871c1b8305,22.0.1-4-g3a563be+32dcf1063f,22.0.1-4-g44f2e3d+9e4ab0f4fa,22.0.1-42-gca6935d93+ba5e5ca3eb,22.0.1-5-g15c806e+85460ae5f3,22.0.1-5-g58711c4+611d128589,22.0.1-5-g75bb458+99c117b92f,22.0.1-6-g1c63a23+7fa3b7d9b6,22.0.1-6-g50866e6+84ff5a128b,22.0.1-6-g8d3140d+720564cf76,22.0.1-6-gd805d02+cc5644f571,22.0.1-8-ge5750ce+85460ae5f3,master-g6e05de7fdc+babf819c66,master-g99da0e417a+8d77f4f51a,w.2021.48
LSST Data Management Base Package
Public Types | Public Member Functions | Static Public Member Functions | Protected Types | Protected Member Functions | Friends | List of all members
lsst::afw::geom::Transform< FromEndpoint, ToEndpoint > Class Template Referencefinal

Transform LSST spatial data, such as lsst::geom::Point2D and lsst::geom::SpherePoint, using an AST mapping. More...

#include <Transform.h>

Inheritance diagram for lsst::afw::geom::Transform< FromEndpoint, ToEndpoint >:
lsst::afw::table::io::PersistableFacade< Transform< FromEndpoint, ToEndpoint > > lsst::afw::table::io::Persistable

Public Types

using FromArray = typename FromEndpoint::Array
 
using FromPoint = typename FromEndpoint::Point
 
using ToArray = typename ToEndpoint::Array
 
using ToPoint = typename ToEndpoint::Point
 

Public Member Functions

 Transform (Transform const &)=default
 
 Transform (Transform &&)=default
 
Transformoperator= (Transform const &)=delete
 
Transformoperator= (Transform &&)=delete
 
 ~Transform () override=default
 
 Transform (ast::Mapping const &mapping, bool simplify=true)
 Construct a Transform from a deep copy of an ast::Mapping. More...
 
 Transform (ast::FrameSet const &frameSet, bool simplify=true)
 Construct a Transform from a deep copy of a ast::FrameSet. More...
 
bool hasForward () const
 Test if this method has a forward transform. More...
 
bool hasInverse () const
 Test if this method has an inverse transform. More...
 
FromEndpoint getFromEndpoint () const
 Get the "from" endpoint. More...
 
std::shared_ptr< const ast::MappinggetMapping () const
 Get the contained mapping. More...
 
ToEndpoint getToEndpoint () const
 Get the "to" endpoint. More...
 
ToPoint applyForward (FromPoint const &point) const
 Transform one point in the forward direction ("from" to "to") More...
 
ToArray applyForward (FromArray const &array) const
 Transform an array of points in the forward direction ("from" to "to") More...
 
FromPoint applyInverse (ToPoint const &point) const
 Transform one point in the inverse direction ("to" to "from") More...
 
FromArray applyInverse (ToArray const &array) const
 Transform an array of points in the inverse direction ("to" to "from") More...
 
std::shared_ptr< Transform< ToEndpoint, FromEndpoint > > inverted () const
 The inverse of this Transform. More...
 
Eigen::MatrixXd getJacobian (FromPoint const &x) const
 The Jacobian matrix of this Transform. More...
 
template<class NextToEndpoint >
std::shared_ptr< Transform< FromEndpoint, NextToEndpoint > > then (Transform< ToEndpoint, NextToEndpoint > const &next, bool simplify=true) const
 Concatenate two Transforms. More...
 
void writeStream (std::ostream &os) const
 Serialize this Transform to an output stream. More...
 
std::string writeString () const
 Serialize this Transform to a string, using the same format as writeStream. More...
 
bool isPersistable () const noexcept override
 Whether the Transform is persistable via afw::table::io (always true). More...
 
void writeFits (std::string const &fileName, std::string const &mode="w") const
 Write the object to a regular FITS file. More...
 
void writeFits (fits::MemFileManager &manager, std::string const &mode="w") const
 Write the object to a FITS image in memory. More...
 
void writeFits (fits::Fits &fitsfile) const
 Write the object to an already-open FITS object. More...
 

Static Public Member Functions

static std::string getShortClassName ()
 Return a short version of the class name with no punctuation. More...
 
static std::shared_ptr< Transform< FromEndpoint, ToEndpoint > > readStream (std::istream &is)
 Deserialize a Transform of this type from an input stream. More...
 
static std::shared_ptr< Transform< FromEndpoint, ToEndpoint > > readString (std::string &str)
 Deserialize a Transform of this type from a string, using the same format as readStream. More...
 
static std::shared_ptr< Transform< FromEndpoint, ToEndpoint > > readFits (fits::Fits &fitsfile)
 Read an object from an already open FITS object. More...
 
static std::shared_ptr< Transform< FromEndpoint, ToEndpoint > > readFits (std::string const &fileName, int hdu=fits::DEFAULT_HDU)
 Read an object from a regular FITS file. More...
 
static std::shared_ptr< Transform< FromEndpoint, ToEndpoint > > readFits (fits::MemFileManager &manager, int hdu=fits::DEFAULT_HDU)
 Read an object from a FITS file in memory. More...
 
static std::shared_ptr< Transform< FromEndpoint, ToEndpoint > > dynamicCast (std::shared_ptr< Persistable > const &ptr)
 Dynamically cast a shared_ptr. More...
 

Protected Types

using OutputArchiveHandle = io::OutputArchiveHandle
 

Protected Member Functions

 Transform (std::shared_ptr< ast::Mapping > mapping)
 Construct a Transform from a shared pointer to an ast::Mapping. More...
 
std::string getPersistenceName () const override
 Return the unique name used to persist this object and look up its factory. More...
 
std::string getPythonModule () const override
 Return the fully-qualified Python module that should be imported to guarantee that its factory is registered. More...
 
void write (OutputArchiveHandle &handle) const override
 Write the object to one or more catalogs. More...
 

Friends

class SkyWcs
 

Detailed Description

template<class FromEndpoint, class ToEndpoint>
class lsst::afw::geom::Transform< FromEndpoint, ToEndpoint >

Transform LSST spatial data, such as lsst::geom::Point2D and lsst::geom::SpherePoint, using an AST mapping.

This class contains two Endpoints, to specify the "from" and "to" LSST data type, and an ast::Mapping to specify the transformation.

Depending on the ast::FrameSet or ast::Mapping used to define it, a Transform may provide either a forward transform, an inverse transform, or both. In particular, the inverse of a forward-only transform is an inverse-only transform. The hasForward and hasInverse methods can be used to check which transforms are available.

Unless otherwise stated, all constructors and methods may throw std::runtime_error to indicate internal errors within AST.

Transforms are always immutable.

Note
You gain some safety by constructing a Transform from an ast::FrameSet, since the base and current frames in the FrameSet can be checked against by the appropriate endpoint.
"In place" versions of applyForward and applyInverse are not available because data must be copied when converting from LSST data types to the type used by astshim, so it didn't seem worth the bother.

Definition at line 67 of file Transform.h.

Member Typedef Documentation

◆ FromArray

template<class FromEndpoint , class ToEndpoint >
using lsst::afw::geom::Transform< FromEndpoint, ToEndpoint >::FromArray = typename FromEndpoint::Array

Definition at line 73 of file Transform.h.

◆ FromPoint

template<class FromEndpoint , class ToEndpoint >
using lsst::afw::geom::Transform< FromEndpoint, ToEndpoint >::FromPoint = typename FromEndpoint::Point

Definition at line 74 of file Transform.h.

◆ OutputArchiveHandle

using lsst::afw::table::io::Persistable::OutputArchiveHandle = io::OutputArchiveHandle
protectedinherited

Definition at line 108 of file Persistable.h.

◆ ToArray

template<class FromEndpoint , class ToEndpoint >
using lsst::afw::geom::Transform< FromEndpoint, ToEndpoint >::ToArray = typename ToEndpoint::Array

Definition at line 75 of file Transform.h.

◆ ToPoint

template<class FromEndpoint , class ToEndpoint >
using lsst::afw::geom::Transform< FromEndpoint, ToEndpoint >::ToPoint = typename ToEndpoint::Point

Definition at line 76 of file Transform.h.

Constructor & Destructor Documentation

◆ Transform() [1/5]

template<class FromEndpoint , class ToEndpoint >
lsst::afw::geom::Transform< FromEndpoint, ToEndpoint >::Transform ( Transform< FromEndpoint, ToEndpoint > const &  )
default

◆ Transform() [2/5]

template<class FromEndpoint , class ToEndpoint >
lsst::afw::geom::Transform< FromEndpoint, ToEndpoint >::Transform ( Transform< FromEndpoint, ToEndpoint > &&  )
default

◆ ~Transform()

template<class FromEndpoint , class ToEndpoint >
lsst::afw::geom::Transform< FromEndpoint, ToEndpoint >::~Transform ( )
overridedefault

◆ Transform() [3/5]

template<class FromEndpoint , class ToEndpoint >
lsst::afw::geom::Transform< FromEndpoint, ToEndpoint >::Transform ( ast::Mapping const &  mapping,
bool  simplify = true 
)
explicit

Construct a Transform from a deep copy of an ast::Mapping.

Parameters
[in]mappingast::Mapping describing the desired transformation
[in]simplifySimplify the mapping? This combines component mappings where it is possible to do so without affecting accuracy.

Definition at line 44 of file Transform.cc.

45  : _fromEndpoint(mapping.getNIn()),
46  _mapping(simplify ? mapping.simplified() : mapping.copy()),
47  _toEndpoint(mapping.getNOut()) {}

◆ Transform() [4/5]

template<typename FromEndpoint , typename ToEndpoint >
lsst::afw::geom::Transform< FromEndpoint, ToEndpoint >::Transform ( ast::FrameSet const &  frameSet,
bool  simplify = true 
)
explicit

Construct a Transform from a deep copy of a ast::FrameSet.

The result transforms from the "base" frame to the "current" frame of the provided FrameSet. The "from" endpoint is used to normalize the "base" frame and the "to" endpoint is used to normalize the "current" frame.

This is pickier than the constructor that takes an ast::Mapping in that:

  • SpherePointEndpoint must be associated with an ast::SkyFrame and the SkyFrame axes are transposed, if necessary, to give the standard order: longitude, latitude.
  • Point2Endpoint must be associated with an ast::Frame (not a subclass), because Frame is the only kind of Frame that is sure to be Cartesian.
Parameters
[in]frameSetast::FrameSet describing the desired transformation in the usual way: from "base" frame to "current" frame
[in]simplifySimplify the mapping? This combines component mappings where it is possible to do so without affecting accuracy.

Definition at line 50 of file Transform.cc.

51  : _fromEndpoint(frameSet.getNIn()), _mapping(), _toEndpoint(frameSet.getNOut()) {
52  auto frameSetCopy = frameSet.copy();
53  // Normalize the base and current frame in a way that affects its behavior as a mapping.
54  // To do this one must set the current frame to the frame to be normalized
55  // and normalize the frame set as a frame (i.e. normalize the frame "in situ").
56  // The obvious alternative of normalizing a shallow copy of the frame does not work;
57  // the frame is altered but not the associated mapping!
58 
59  // Normalize the current frame by normalizing the frameset as a frame
60  _toEndpoint.normalizeFrame(frameSetCopy);
61 
62  // Normalize the base frame by temporarily making it the current frame,
63  // normalizing the frameset as a frame, then making it the base frame again
64  const int baseIndex = frameSetCopy->getBase();
65  const int currentIndex = frameSetCopy->getCurrent();
66  frameSetCopy->setCurrent(baseIndex);
67  _fromEndpoint.normalizeFrame(frameSetCopy);
68  frameSetCopy->setBase(baseIndex);
69  frameSetCopy->setCurrent(currentIndex);
70  _mapping = simplify ? frameSetCopy->getMapping()->simplified() : frameSetCopy->getMapping();
71 }
table::Key< table::Array< std::uint8_t > > frameSet
std::shared_ptr< Mapping > simplified() const
Return a simplied version of the mapping (which may be a compound Mapping such as a CmpMap).
Definition: Mapping.h:248

◆ Transform() [5/5]

template<typename FromEndpoint , typename ToEndpoint >
lsst::afw::geom::Transform< FromEndpoint, ToEndpoint >::Transform ( std::shared_ptr< ast::Mapping mapping)
explicitprotected

Construct a Transform from a shared pointer to an ast::Mapping.

Definition at line 74 of file Transform.cc.

75  : _fromEndpoint(mapping->getNIn()), _mapping(mapping), _toEndpoint(mapping->getNOut()) {}
int getNOut() const
Get NOut: the number of output axes.
Definition: Mapping.h:82
int getNIn() const
Get NIn: the number of input axes.
Definition: Mapping.h:77

Member Function Documentation

◆ applyForward() [1/2]

template<class FromEndpoint , class ToEndpoint >
ToArray lsst::afw::geom::Transform< FromEndpoint, ToEndpoint >::applyForward ( FromArray const &  array) const

Transform an array of points in the forward direction ("from" to "to")

The first dimension of the array must match the number of input axes, and the data order is values for the first axis, then values for the next axis, and so on, e.g. for 2 axes: x0, x1, x2, ..., y0, y1, y2...

◆ applyForward() [2/2]

template<class FromEndpoint , class ToEndpoint >
ToPoint lsst::afw::geom::Transform< FromEndpoint, ToEndpoint >::applyForward ( FromPoint const &  point) const

Transform one point in the forward direction ("from" to "to")

◆ applyInverse() [1/2]

template<class FromEndpoint , class ToEndpoint >
FromArray lsst::afw::geom::Transform< FromEndpoint, ToEndpoint >::applyInverse ( ToArray const &  array) const

Transform an array of points in the inverse direction ("to" to "from")

The first dimension of the array must match the number of output axes, and the data order is values for the first axis, then values for the next axis, and so on, e.g. for 2 axes: x0, x1, x2, ..., y0, y1, y2...

◆ applyInverse() [2/2]

template<class FromEndpoint , class ToEndpoint >
FromPoint lsst::afw::geom::Transform< FromEndpoint, ToEndpoint >::applyInverse ( ToPoint const &  point) const

Transform one point in the inverse direction ("to" to "from")

◆ dynamicCast()

template std::shared_ptr< meas::extensions::psfex::PsfexPsf > lsst::afw::table::io::PersistableFacade< Transform< FromEndpoint, ToEndpoint > >::dynamicCast ( std::shared_ptr< Persistable > const &  ptr)
staticinherited

Dynamically cast a shared_ptr.

Dynamically cast a shared pointer and raise on failure.

You must provide an explicit template instantiation in the .cc file for each class that inherits from PersistableFacade. Designed to work around RTTI issues on macOS with hidden symbols;

Exceptions
lsst::pex::exceptions::LogicErrorif the cast fails

param[in] ptr The pointer to be cast.

Returns
The cast pointer.
Exceptions
lsst::pex::exceptions::TypeErrorIf the dynamic cast fails.

Definition at line 218 of file Persistable.cc.

18  {
19  auto result = std::dynamic_pointer_cast<T>(ptr);
20  if (!result) {
21  throw LSST_EXCEPT(pex::exceptions::TypeError, "Dynamic pointer cast failed");
22  }
23  return result;
24 }
py::object result
Definition: _schema.cc:429
#define LSST_EXCEPT(type,...)
Create an exception with a given type.
Definition: Exception.h:48
uint64_t * ptr
Definition: RangeSet.cc:88

◆ getFromEndpoint()

template<class FromEndpoint , class ToEndpoint >
FromEndpoint lsst::afw::geom::Transform< FromEndpoint, ToEndpoint >::getFromEndpoint ( ) const
inline

Get the "from" endpoint.

Definition at line 130 of file Transform.h.

130 { return _fromEndpoint; }

◆ getJacobian()

template<class FromEndpoint , class ToEndpoint >
Eigen::MatrixXd lsst::afw::geom::Transform< FromEndpoint, ToEndpoint >::getJacobian ( FromPoint const &  x) const

The Jacobian matrix of this Transform.

Radians are used for each axis of an SpherePointEndpoint.

The matrix is defined only if this object has a forward transform.

Parameters
xthe position at which the Jacobian shall be evaluated
Returns
a matrix J with getToEndpoint().getNAxes() rows and getFromEndpoint().getNAxes() columns. J(i,j) shall be the rate of change of the ith output coordinate with respect to the jth input coordinate, or NaN if the derivative cannot be calculated.
Exception Safety
Provides basic exception safety.
Note
The derivatives may be estimated by sampling and interpolating this Transform in the neighborhood of x. If the implementation requires interpolation, computation of the Jacobian may require hundreds of evaluations of applyForward.

Definition at line 122 of file Transform.cc.

122  {
123  int const nIn = _fromEndpoint.getNAxes();
124  int const nOut = _toEndpoint.getNAxes();
125  std::vector<double> const point = _fromEndpoint.dataFromPoint(x);
126 
127  Eigen::MatrixXd jacobian(nOut, nIn);
128  for (int i = 0; i < nOut; ++i) {
129  for (int j = 0; j < nIn; ++j) {
130  jacobian(i, j) = _mapping->rate(point, i + 1, j + 1);
131  }
132  }
133  return jacobian;
134 }
double x
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...
Definition: Mapping.h:215

◆ getMapping()

template<class FromEndpoint , class ToEndpoint >
std::shared_ptr<const ast::Mapping> lsst::afw::geom::Transform< FromEndpoint, ToEndpoint >::getMapping ( ) const
inline

Get the contained mapping.

Definition at line 135 of file Transform.h.

135 { return _mapping; }

◆ getPersistenceName()

template<class FromEndpoint , class ToEndpoint >
std::string lsst::afw::geom::Transform< FromEndpoint, ToEndpoint >::getPersistenceName ( ) const
inlineoverrideprotectedvirtual

Return the unique name used to persist this object and look up its factory.

Must be less than ArchiveIndexSchema::MAX_NAME_LENGTH characters.

Reimplemented from lsst::afw::table::io::Persistable.

Definition at line 274 of file Transform.h.

274 { return getShortClassName(); }
static std::string getShortClassName()
Return a short version of the class name with no punctuation.
Definition: Transform.cc:137

◆ getPythonModule()

template<class FromEndpoint , class ToEndpoint >
std::string lsst::afw::geom::Transform< FromEndpoint, ToEndpoint >::getPythonModule ( ) const
inlineoverrideprotectedvirtual

Return the fully-qualified Python module that should be imported to guarantee that its factory is registered.

Must be less than ArchiveIndexSchema::MAX_MODULE_LENGTH characters.

Will be ignored if empty.

Reimplemented from lsst::afw::table::io::Persistable.

Definition at line 277 of file Transform.h.

277 { return "lsst.afw.geom"; }

◆ getShortClassName()

template<class FromEndpoint , class ToEndpoint >
std::string lsst::afw::geom::Transform< FromEndpoint, ToEndpoint >::getShortClassName
static

Return a short version of the class name with no punctuation.

Used as the Python class name and for persistence as a string

Returns "Transform" + fromEndpoint.getClassPrefix() + "To" + toEndpoint.getClassPrefix(), for example "TransformPoint2ToSpherePoint" or "TransformPoint2ToGeneric".

Definition at line 137 of file Transform.cc.

137  {
139  os << "Transform" << FromEndpoint::getClassPrefix() << "To" << ToEndpoint::getClassPrefix();
140  return os.str();
141 }
std::ostream * os
Definition: Schema.cc:557

◆ getToEndpoint()

template<class FromEndpoint , class ToEndpoint >
ToEndpoint lsst::afw::geom::Transform< FromEndpoint, ToEndpoint >::getToEndpoint ( ) const
inline

Get the "to" endpoint.

Definition at line 140 of file Transform.h.

140 { return _toEndpoint; }

◆ hasForward()

template<class FromEndpoint , class ToEndpoint >
bool lsst::afw::geom::Transform< FromEndpoint, ToEndpoint >::hasForward ( ) const
inline

Test if this method has a forward transform.

Exception Safety
Provides basic exception safety.

Definition at line 118 of file Transform.h.

118 { return _mapping->hasForward(); }
bool hasForward() const
Is the forward transform available?
Definition: Mapping.h:114

◆ hasInverse()

template<class FromEndpoint , class ToEndpoint >
bool lsst::afw::geom::Transform< FromEndpoint, ToEndpoint >::hasInverse ( ) const
inline

Test if this method has an inverse transform.

Exception Safety
Provides basic exception safety.

Definition at line 125 of file Transform.h.

125 { return _mapping->hasInverse(); }
bool hasInverse() const
Is the inverse transform available?
Definition: Mapping.h:123

◆ inverted()

template<class FromEndpoint , class ToEndpoint >
std::shared_ptr< Transform< ToEndpoint, FromEndpoint > > lsst::afw::geom::Transform< FromEndpoint, ToEndpoint >::inverted

The inverse of this Transform.

Returns
a Transform whose applyForward is equivalent to this Transform's applyInverse, and vice versa.
Exception Safety
Provides basic exception safety.

Definition at line 110 of file Transform.cc.

110  {
111  auto inverse = std::dynamic_pointer_cast<ast::Mapping>(_mapping->inverted());
112  if (!inverse) {
113  // don't throw std::bad_cast because it doesn't let you provide debugging info
114  std::ostringstream buffer;
115  buffer << "Mapping.inverted() does not return a Mapping. Called from: " << _mapping;
116  throw LSST_EXCEPT(pex::exceptions::LogicError, buffer.str());
117  }
118  return std::make_shared<Transform<ToEndpoint, FromEndpoint>>(*inverse);
119 }
std::shared_ptr< Mapping > inverted() const
Get an inverse mapping.
Definition: Mapping.cc:41
T str(T... args)

◆ isPersistable()

template<class FromEndpoint , class ToEndpoint >
bool lsst::afw::geom::Transform< FromEndpoint, ToEndpoint >::isPersistable ( ) const
inlineoverridevirtualnoexcept

Whether the Transform is persistable via afw::table::io (always true).

Reimplemented from lsst::afw::table::io::Persistable.

Definition at line 265 of file Transform.h.

265 { return true; }

◆ operator=() [1/2]

template<class FromEndpoint , class ToEndpoint >
Transform& lsst::afw::geom::Transform< FromEndpoint, ToEndpoint >::operator= ( Transform< FromEndpoint, ToEndpoint > &&  )
delete

◆ operator=() [2/2]

template<class FromEndpoint , class ToEndpoint >
Transform& lsst::afw::geom::Transform< FromEndpoint, ToEndpoint >::operator= ( Transform< FromEndpoint, ToEndpoint > const &  )
delete

◆ readFits() [1/3]

static std::shared_ptr<Transform< FromEndpoint, ToEndpoint > > lsst::afw::table::io::PersistableFacade< Transform< FromEndpoint, ToEndpoint > >::readFits ( fits::Fits fitsfile)
inlinestaticinherited

Read an object from an already open FITS object.

Parameters
[in]fitsfileFITS object to read from, already positioned at the desired HDU.

Definition at line 183 of file Persistable.h.

183  {
184  return dynamicCast(Persistable::_readFits(fitsfile));
185  }
static std::shared_ptr< Transform< FromEndpoint, ToEndpoint > > dynamicCast(std::shared_ptr< Persistable > const &ptr)
Dynamically cast a shared_ptr.
Definition: Persistable.cc:18

◆ readFits() [2/3]

static std::shared_ptr<Transform< FromEndpoint, ToEndpoint > > lsst::afw::table::io::PersistableFacade< Transform< FromEndpoint, ToEndpoint > >::readFits ( fits::MemFileManager manager,
int  hdu = fits::DEFAULT_HDU 
)
inlinestaticinherited

Read an object from a FITS file in memory.

Parameters
[in]managerManager for the memory to read from.
[in]hduHDU to read, where 0 is the primary. The special value of afw::fits::DEFAULT_HDU skips the primary HDU if it is empty.

Definition at line 205 of file Persistable.h.

205  {
206  return dynamicCast(Persistable::_readFits(manager, hdu));
207  }

◆ readFits() [3/3]

static std::shared_ptr<Transform< FromEndpoint, ToEndpoint > > lsst::afw::table::io::PersistableFacade< Transform< FromEndpoint, ToEndpoint > >::readFits ( std::string const &  fileName,
int  hdu = fits::DEFAULT_HDU 
)
inlinestaticinherited

Read an object from a regular FITS file.

Parameters
[in]fileNameName of the file to read.
[in]hduHDU to read, where 0 is the primary. The special value of afw::fits::DEFAULT_HDU skips the primary HDU if it is empty.

Definition at line 194 of file Persistable.h.

194  {
195  return dynamicCast(Persistable::_readFits(fileName, hdu));
196  }

◆ readStream()

template<class FromEndpoint , class ToEndpoint >
std::shared_ptr< Transform< FromEndpoint, ToEndpoint > > lsst::afw::geom::Transform< FromEndpoint, ToEndpoint >::readStream ( std::istream is)
static

Deserialize a Transform of this type from an input stream.

Parameters
[in]isinput stream from which to deserialize this Transform

Definition at line 144 of file Transform.cc.

145  {
146  return detail::readStream<Transform<FromEndpoint, ToEndpoint>>(is);
147 }

◆ readString()

template<class FromEndpoint , class ToEndpoint >
std::shared_ptr< Transform< FromEndpoint, ToEndpoint > > lsst::afw::geom::Transform< FromEndpoint, ToEndpoint >::readString ( std::string str)
static

Deserialize a Transform of this type from a string, using the same format as readStream.

Definition at line 150 of file Transform.cc.

151  {
152  std::istringstream is(str);
154 }
static std::shared_ptr< Transform< FromEndpoint, ToEndpoint > > readStream(std::istream &is)
Deserialize a Transform of this type from an input stream.
Definition: Transform.cc:144

◆ then()

template<class FromEndpoint , class ToEndpoint >
template<class NextToEndpoint >
template std::shared_ptr< Transform< SpherePointEndpoint, SpherePointEndpoint > > lsst::afw::geom::Transform< FromEndpoint, ToEndpoint >::then< SpherePointEndpoint > ( Transform< ToEndpoint, NextToEndpoint > const &  next,
bool  simplify = true 
) const

Concatenate two Transforms.

Template Parameters
NextToEndpointthe "to" Endpoint of next
Parameters
nextthe Transform to apply after this one
simplifyif true then produce a transform containing a single simplified mapping with no intermediate frames.
Returns
a Transform that first applies this transform to its input, and then next to the result. Its inverse shall first apply the inverse of next, and then the inverse of this transform.
Exceptions
pex::exceptions::InvalidParameterErrorThrown if getToEndpoint() and next.getFromEndpoint() do not have the same number of axes.
Exception Safety
Provides basic exception safety.

More than two Transforms can be combined in series. For example:

auto pixelsToSky = pixelsToFp.then(fpToField)->then(fieldToSky);

Definition at line 170 of file Transform.cc.

171  {
172  if (_toEndpoint.getNAxes() == next.getFromEndpoint().getNAxes()) {
173  auto nextMapping = next.getMapping();
174  auto combinedMapping = getMapping()->then(*next.getMapping());
175  if (simplify) {
176  return std::make_shared<Transform<FromEndpoint, NextToEndpoint>>(*combinedMapping.simplified());
177  } else {
178  return std::make_shared<Transform<FromEndpoint, NextToEndpoint>>(combinedMapping);
179  }
180  } else {
181  auto message = "Cannot match " + std::to_string(_toEndpoint.getNAxes()) + "-D to-endpoint to " +
182  std::to_string(next.getFromEndpoint().getNAxes()) + "-D from-endpoint.";
183  throw LSST_EXCEPT(pex::exceptions::InvalidParameterError, message);
184  }
185 }
SeriesMap then(Mapping const &next) const
Return a series compound mapping this(first(input)) containing shallow copies of the original.
Definition: Mapping.cc:37
std::shared_ptr< const ast::Mapping > getMapping() const
Get the contained mapping.
Definition: Transform.h:135
T to_string(T... args)

◆ write()

template<class FromEndpoint , class ToEndpoint >
void lsst::afw::geom::Transform< FromEndpoint, ToEndpoint >::write ( OutputArchiveHandle handle) const
overrideprotectedvirtual

Write the object to one or more catalogs.

The handle object passed to this function provides an interface for adding new catalogs and adding nested objects to the same archive (while checking for duplicates). See OutputArchiveHandle for more information.

Reimplemented from lsst::afw::table::io::Persistable.

Definition at line 240 of file Transform.cc.

240  {
241  auto const &keys = TransformPersistenceHelper::get();
242  table::BaseCatalog cat = handle.makeCatalog(keys.schema);
243  std::shared_ptr<table::BaseRecord> record = cat.addNew();
244  record->set(keys.bytes, formatters::stringToBytes(writeString()));
245  handle.saveCatalog(cat);
246 }
std::string writeString() const
Serialize this Transform to a string, using the same format as writeStream.
Definition: Transform.cc:162
ndarray::Array< std::uint8_t, 1, 1 > stringToBytes(std::string const &str)
Encode a std::string as a vector of uint8.
Definition: Utils.cc:161
CatalogT< BaseRecord > BaseCatalog
Definition: fwd.h:72

◆ writeFits() [1/3]

void lsst::afw::table::io::Persistable::writeFits ( fits::Fits fitsfile) const
inherited

Write the object to an already-open FITS object.

Parameters
[in]fitsfileOpen FITS object to write to.

Definition at line 18 of file Persistable.cc.

18  {
19  OutputArchive archive;
20  archive.put(this);
21  archive.writeFits(fitsfile);
22 }

◆ writeFits() [2/3]

void lsst::afw::table::io::Persistable::writeFits ( fits::MemFileManager manager,
std::string const &  mode = "w" 
) const
inherited

Write the object to a FITS image in memory.

Parameters
[in]managerName of the file to write to.
[in]modeIf "w", any existing file with the given name will be overwritten. If "a", new HDUs will be appended to an existing file.

Definition at line 29 of file Persistable.cc.

29  {
30  fits::Fits fitsfile(manager, mode, fits::Fits::AUTO_CLOSE | fits::Fits::AUTO_CHECK);
31  writeFits(fitsfile);
32 }
void writeFits(std::string const &fileName, std::string const &mode="w") const
Write the object to a regular FITS file.
Definition: Persistable.cc:24

◆ writeFits() [3/3]

void lsst::afw::table::io::Persistable::writeFits ( std::string const &  fileName,
std::string const &  mode = "w" 
) const
inherited

Write the object to a regular FITS file.

Parameters
[in]fileNameName of the file to write to.
[in]modeIf "w", any existing file with the given name will be overwritten. If "a", new HDUs will be appended to an existing file.

Definition at line 24 of file Persistable.cc.

24  {
25  fits::Fits fitsfile(fileName, mode, fits::Fits::AUTO_CLOSE | fits::Fits::AUTO_CHECK);
26  writeFits(fitsfile);
27 }

◆ writeStream()

template<class FromEndpoint , class ToEndpoint >
void lsst::afw::geom::Transform< FromEndpoint, ToEndpoint >::writeStream ( std::ostream os) const

Serialize this Transform to an output stream.

Version 1 format is as follows:

  • The version number (an integer)
  • A space
  • The short class name, as obtained from getShortClassName
  • A space
  • The contained ast::FrameSet written using FrameSet.show(os, false)
Parameters
[out]osoutpu stream to which to serialize this Transform

Definition at line 157 of file Transform.cc.

157  {
158  detail::writeStream<Transform<FromEndpoint, ToEndpoint>>(*this, os);
159 }

◆ writeString()

template<class FromEndpoint , class ToEndpoint >
std::string lsst::afw::geom::Transform< FromEndpoint, ToEndpoint >::writeString

Serialize this Transform to a string, using the same format as writeStream.

Definition at line 162 of file Transform.cc.

162  {
164  writeStream(os);
165  return os.str();
166 }
void writeStream(std::ostream &os) const
Serialize this Transform to an output stream.
Definition: Transform.cc:157

Friends And Related Function Documentation

◆ SkyWcs

template<class FromEndpoint , class ToEndpoint >
friend class SkyWcs
friend

Definition at line 70 of file Transform.h.


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