lsst::afw::cameraGeom::DetectorBase Class Reference

An abstract base class that provides common accessors for Detector and Detector::Builder. More...

#include <Detector.h>

Inheritance diagram for lsst::afw::cameraGeom::DetectorBase:

Classes
struct	Fields

Public Types
using	CrosstalkMatrix = ndarray::Array<float const, 2>

Public Member Functions
virtual	~DetectorBase () noexcept=default
std::string	getName () const
	Get the detector name.
int	getId () const
	Get the detector ID.
DetectorType	getType () const
	Return the purpose of this detector.
std::string	getSerial () const
	Get the detector serial "number".
std::string	getPhysicalType () const
	Get the detector's physical type.
lsst::geom::Box2I	getBBox () const
	Get the bounding box.
Orientation	getOrientation () const
	Get detector's orientation in the focal plane.
lsst::geom::Extent2D	getPixelSize () const
	Get size of pixel along (mm)
bool	hasCrosstalk () const
	Have we got crosstalk coefficients?
CrosstalkMatrix	getCrosstalk () const
	Get the crosstalk coefficients.
CameraSys	makeCameraSys (CameraSys const &cameraSys) const
	Get a coordinate system from a coordinate system (return input unchanged and untested)
CameraSys	makeCameraSys (CameraSysPrefix const &cameraSysPrefix) const
	Get a coordinate system from a detector system prefix (add detector name)
CameraSys	getNativeCoordSys () const
	The "native" coordinate system of this detector.
virtual std::shared_ptr< Storable >	cloneStorable () const
	Create a new object that is a copy of this one (optional operation).
virtual std::string	toString () const
	Create a string representation of this object (optional operation).
virtual std::size_t	hash_value () const
	Return a hash of this object (optional operation).
virtual bool	equals (Storable const &other) const noexcept
	Compare this object to another Storable.
void	writeFits (std::string const &fileName, std::string const &mode="w") const
	Write the object to a regular FITS file.
void	writeFits (fits::MemFileManager &manager, std::string const &mode="w") const
	Write the object to a FITS image in memory.
void	writeFits (fits::Fits &fitsfile) const
	Write the object to an already-open FITS object.
virtual bool	isPersistable () const noexcept
	Return true if this particular object can be persisted using afw::table::io.

Protected Types
using	OutputArchiveHandle = io::OutputArchiveHandle

Protected Member Functions
	DetectorBase ()=default
	DetectorBase has no state, and is hence default-constructable, copyable, and movable.
	DetectorBase (DetectorBase const &)=default
	DetectorBase (DetectorBase &&)=default
DetectorBase &	operator= (DetectorBase const &)=default
DetectorBase &	operator= (DetectorBase &&)=default
virtual Fields const &	getFields () const =0
	Return a reference to a Fields struct.
virtual std::string	getPersistenceName () const
	Return the unique name used to persist this object and look up its factory.
virtual std::string	getPythonModule () const
	Return the fully-qualified Python module that should be imported to guarantee that its factory is registered.
virtual void	write (OutputArchiveHandle &handle) const
	Write the object to one or more catalogs.

Static Protected Member Functions
template<class T>
static bool	singleClassEquals (T const &lhs, Storable const &rhs)
	Test if a Storable is of a particular class and equal to another object.

Related Symbols
(Note that these are not member symbols.)
std::ostream &	operator<< (std::ostream &os, Storable const &storable)
	Output operator for Storable.

Detailed Description

An abstract base class that provides common accessors for Detector and Detector::Builder.

Definition at line 56 of file Detector.h.

Member Typedef Documentation

CrosstalkMatrix

using lsst::afw::cameraGeom::DetectorBase::CrosstalkMatrix = ndarray::Array<float const, 2>

Definition at line 59 of file Detector.h.

OutputArchiveHandle

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

protectedinherited

Definition at line 108 of file Persistable.h.

Constructor & Destructor Documentation

~DetectorBase()

virtual lsst::afw::cameraGeom::DetectorBase::~DetectorBase ( )

virtualdefaultnoexcept

DetectorBase() [1/3]

lsst::afw::cameraGeom::DetectorBase::DetectorBase ( )

protecteddefault

DetectorBase has no state, and is hence default-constructable, copyable, and movable.

DetectorBase() [2/3]

lsst::afw::cameraGeom::DetectorBase::DetectorBase ( DetectorBase const & )

protecteddefault

DetectorBase() [3/3]

lsst::afw::cameraGeom::DetectorBase::DetectorBase ( DetectorBase && )

protecteddefault

Member Function Documentation

cloneStorable()

std::shared_ptr< Storable > lsst::afw::typehandling::Storable::cloneStorable ( ) const

virtualinherited

Create a new object that is a copy of this one (optional operation).

This operation is required for Storables that are stored in GenericMap by value, but not for those stored by shared pointer.

Exceptions

UnsupportedOperationException

Thrown if this object is not cloneable.

Note

If this class supports a clone operation, the two should behave identically except for the formal return type.

When called on Python classes, this method delegates to __deepcopy__ if it exists.

Reimplemented in lsst::afw::detection::Psf, lsst::afw::geom::polygon::Polygon, lsst::afw::geom::SkyWcs, lsst::afw::image::ApCorrMap, lsst::afw::image::CoaddInputs, lsst::afw::image::FilterLabel, lsst::afw::image::PhotoCalib, lsst::afw::image::VisitInfo, and lsst::afw::typehandling::StorableHelper< Base >.

Definition at line 36 of file Storable.cc.

                                                      {
    throw LSST_EXCEPT(UnsupportedOperationException, "Cloning is not supported.");
}

equals()

bool lsst::afw::typehandling::Storable::equals ( Storable const & other ) const

virtualnoexceptinherited

Compare this object to another Storable.

Subclasses that implement equality comparison must override this method to give results consistent with operator== for all inputs that are accepted by both.

Returns

This implementation returns whether the two objects are the same.

Warning

This method compares an object to any type of Storable, although cross-class comparisons should usually return false. If cross-class comparisons are valid, implementers should take care that they are symmetric and will give the same result no matter what the compile-time types of the left- and right-hand sides are.

See also

singleClassEquals

Note

When called on Python classes, this method delegates to __eq__ if it exists.

Reimplemented in lsst::afw::geom::polygon::Polygon, lsst::afw::geom::SkyWcs, lsst::afw::image::PhotoCalib, lsst::afw::image::VisitInfo, and lsst::afw::typehandling::StorableHelper< Base >.

Definition at line 48 of file Storable.cc.

{ return this == &other; }

getBBox()

lsst::geom::Box2I lsst::afw::cameraGeom::DetectorBase::getBBox ( ) const

inline

Get the bounding box.

Definition at line 85 of file Detector.h.

{ return getFields().bbox; }

getCrosstalk()

CrosstalkMatrix lsst::afw::cameraGeom::DetectorBase::getCrosstalk ( ) const

inline

Get the crosstalk coefficients.

Definition at line 100 of file Detector.h.

{ return getFields().crosstalk; }

getFields()

virtual Fields const & lsst::afw::cameraGeom::DetectorBase::getFields ( ) const

protectedpure virtual

Return a reference to a Fields struct.

Must be implemented by all subclasses.

Implemented in lsst::afw::cameraGeom::Detector::Builder, and lsst::afw::cameraGeom::Detector.

getId()

int lsst::afw::cameraGeom::DetectorBase::getId ( ) const

inline

Get the detector ID.

Definition at line 67 of file Detector.h.

{ return getFields().id; }

getName()

std::string lsst::afw::cameraGeom::DetectorBase::getName ( ) const

inline

Get the detector name.

Definition at line 64 of file Detector.h.

{ return getFields().name; }

getNativeCoordSys()

CameraSys lsst::afw::cameraGeom::DetectorBase::getNativeCoordSys ( ) const

inline

The "native" coordinate system of this detector.

Definition at line 123 of file Detector.h.

{ return CameraSys(PIXELS, getName()); }

getOrientation()

Orientation lsst::afw::cameraGeom::DetectorBase::getOrientation ( ) const

inline

Get detector's orientation in the focal plane.

Definition at line 88 of file Detector.h.

{ return getFields().orientation; }

getPersistenceName()

std::string lsst::afw::table::io::Persistable::getPersistenceName ( ) const

protectedvirtualinherited

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

Must be less than ArchiveIndexSchema::MAX_NAME_LENGTH characters.

Reimplemented in lsst::afw::cameraGeom::Camera, lsst::afw::cameraGeom::Detector, lsst::afw::cameraGeom::DetectorCollection, lsst::afw::cameraGeom::TransformMap, lsst::afw::detection::Footprint, lsst::afw::detection::GaussianPsf, lsst::afw::detection::HeavyFootprint< ImagePixelT, MaskPixelT, VariancePixelT >, lsst::afw::detection::HeavyFootprint< ImagePixelT, MaskPixelT, VariancePixelT >::Factory, lsst::afw::detection::HeavyFootprint< ImagePixelT, MaskPixelT, VariancePixelT >, lsst::afw::detection::HeavyFootprint< ImagePixelT, MaskPixelT, VariancePixelT >, lsst::afw::geom::polygon::Polygon, lsst::afw::geom::SkyWcs, lsst::afw::geom::SpanSet, lsst::afw::geom::Transform< FromEndpoint, ToEndpoint >, lsst::afw::geom::Transform< afw::geom::Point2Endpoint, afw::geom::GenericEndpoint >, lsst::afw::geom::Transform< afw::geom::Point2Endpoint, afw::geom::GenericEndpoint >, lsst::afw::geom::Transform< Point2Endpoint, GenericEndpoint >, lsst::afw::geom::Transform< Point2Endpoint, GenericEndpoint >, lsst::afw::geom::Transform< Point2Endpoint, Point2Endpoint >, lsst::afw::geom::Transform< Point2Endpoint, Point2Endpoint >, lsst::afw::geom::Transform< Point2Endpoint, SpherePointEndpoint >, lsst::afw::geom::Transform< Point2Endpoint, SpherePointEndpoint >, lsst::afw::image::ApCorrMap, lsst::afw::image::CoaddInputs, lsst::afw::image::FilterLabel, lsst::afw::image::PhotoCalib, lsst::afw::image::VisitInfo, lsst::afw::math::AnalyticKernel, lsst::afw::math::BilinearWarpingKernel, lsst::afw::math::Chebyshev1Function2< ReturnT >, lsst::afw::math::ChebyshevBoundedField, lsst::afw::math::DeltaFunctionKernel, lsst::afw::math::DoubleGaussianFunction2< ReturnT >, lsst::afw::math::FixedKernel, lsst::afw::math::GaussianFunction2< ReturnT >, lsst::afw::math::LanczosWarpingKernel, lsst::afw::math::LinearCombinationKernel, lsst::afw::math::NearestWarpingKernel, lsst::afw::math::PixelAreaBoundedField, lsst::afw::math::PolynomialFunction2< ReturnT >, lsst::afw::math::ProductBoundedField, lsst::afw::math::TransformBoundedField, lsst::afw::math::WarpingControl, lsst::afw::typehandling::StorableHelper< Base >, lsst::meas::algorithms::CoaddBoundedField, lsst::meas::algorithms::CoaddPsf, lsst::meas::algorithms::DoubleGaussianPsf, lsst::meas::algorithms::KernelPsf, lsst::meas::algorithms::PcaPsf, lsst::meas::algorithms::SingleGaussianPsf, lsst::meas::algorithms::WarpedPsf, lsst::meas::extensions::psfex::PsfexPsf, and lsst::meas::modelfit::Mixture.

Definition at line 34 of file Persistable.cc.

{ return std::string(); }

getPhysicalType()

std::string lsst::afw::cameraGeom::DetectorBase::getPhysicalType ( ) const

inline

Get the detector's physical type.

This may mean different things for different cameras; possibilities include the manufacturer ("ITL" vs "E2V") or fundamental technology ("CCD" vs "HgCdTe").

Definition at line 82 of file Detector.h.

{ return getFields().physicalType; }

getPixelSize()

lsst::geom::Extent2D lsst::afw::cameraGeom::DetectorBase::getPixelSize ( ) const

inline

Get size of pixel along (mm)

Definition at line 91 of file Detector.h.

{ return getFields().pixelSize; }

getPythonModule()

std::string lsst::afw::table::io::Persistable::getPythonModule ( ) const

protectedvirtualinherited

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 in lsst::afw::cameraGeom::Detector, lsst::afw::cameraGeom::DetectorCollection, lsst::afw::cameraGeom::TransformMap, lsst::afw::detection::Footprint, lsst::afw::detection::GaussianPsf, lsst::afw::geom::SkyWcs, lsst::afw::geom::SpanSet, lsst::afw::geom::Transform< FromEndpoint, ToEndpoint >, lsst::afw::geom::Transform< afw::geom::Point2Endpoint, afw::geom::GenericEndpoint >, lsst::afw::geom::Transform< afw::geom::Point2Endpoint, afw::geom::GenericEndpoint >, lsst::afw::geom::Transform< Point2Endpoint, GenericEndpoint >, lsst::afw::geom::Transform< Point2Endpoint, GenericEndpoint >, lsst::afw::geom::Transform< Point2Endpoint, Point2Endpoint >, lsst::afw::geom::Transform< Point2Endpoint, Point2Endpoint >, lsst::afw::geom::Transform< Point2Endpoint, SpherePointEndpoint >, lsst::afw::geom::Transform< Point2Endpoint, SpherePointEndpoint >, lsst::afw::image::ApCorrMap, lsst::afw::image::CoaddInputs, lsst::afw::image::FilterLabel, lsst::afw::image::TransmissionCurve, lsst::afw::math::BilinearWarpingKernel, lsst::afw::math::ChebyshevBoundedField, lsst::afw::math::Function< ReturnT >, lsst::afw::math::Function< Kernel::Pixel >, lsst::afw::math::Kernel, lsst::afw::math::LanczosWarpingKernel, lsst::afw::math::NearestWarpingKernel, lsst::afw::math::PixelAreaBoundedField, lsst::afw::math::ProductBoundedField, lsst::afw::math::TransformBoundedField, lsst::afw::math::WarpingControl, lsst::afw::typehandling::StorableHelper< Base >, lsst::meas::algorithms::CoaddBoundedField, lsst::meas::algorithms::CoaddPsf, lsst::meas::algorithms::KernelPsf, lsst::meas::algorithms::WarpedPsf, lsst::meas::extensions::psfex::PsfexPsf, and lsst::meas::modelfit::Mixture.

Definition at line 36 of file Persistable.cc.

{ return std::string(); }

getSerial()

std::string lsst::afw::cameraGeom::DetectorBase::getSerial ( ) const

inline

Get the detector serial "number".

Definition at line 73 of file Detector.h.

{ return getFields().serial; }

getType()

DetectorType lsst::afw::cameraGeom::DetectorBase::getType ( ) const

inline

Return the purpose of this detector.

Definition at line 70 of file Detector.h.

{ return getFields().type; }

hasCrosstalk()

bool lsst::afw::cameraGeom::DetectorBase::hasCrosstalk ( ) const

inline

Have we got crosstalk coefficients?

Definition at line 94 of file Detector.h.

                              {
        return !(getFields().crosstalk.isEmpty() ||
                 getFields().crosstalk.getShape() == ndarray::makeVector(0, 0));
    }

hash_value()

std::size_t lsst::afw::typehandling::Storable::hash_value ( ) const

virtualinherited

Return a hash of this object (optional operation).

Exceptions

UnsupportedOperationException

Thrown if this object is not hashable.

Note

C++ subclass authors are responsible for any associated specializations of std::hash.

When called on Python classes, this method delegates to __hash__ if it exists.

Reimplemented in lsst::afw::geom::polygon::Polygon, lsst::afw::image::FilterLabel, lsst::afw::image::VisitInfo, and lsst::afw::typehandling::StorableHelper< Base >.

Definition at line 44 of file Storable.cc.

                                     {
    throw LSST_EXCEPT(UnsupportedOperationException, "Hashes are not supported.");
}

isPersistable()

virtual bool lsst::afw::table::io::Persistable::isPersistable ( ) const

inlinevirtualnoexceptinherited

Return true if this particular object can be persisted using afw::table::io.

Reimplemented in lsst::afw::cameraGeom::Camera, lsst::afw::cameraGeom::Detector, lsst::afw::cameraGeom::DetectorCollection, lsst::afw::cameraGeom::TransformMap, lsst::afw::detection::Footprint, lsst::afw::detection::GaussianPsf, lsst::afw::geom::polygon::Polygon, lsst::afw::geom::SkyWcs, lsst::afw::geom::SpanSet, lsst::afw::geom::Transform< FromEndpoint, ToEndpoint >, lsst::afw::geom::Transform< afw::geom::Point2Endpoint, afw::geom::GenericEndpoint >, lsst::afw::geom::Transform< afw::geom::Point2Endpoint, afw::geom::GenericEndpoint >, lsst::afw::geom::Transform< Point2Endpoint, GenericEndpoint >, lsst::afw::geom::Transform< Point2Endpoint, GenericEndpoint >, lsst::afw::geom::Transform< Point2Endpoint, Point2Endpoint >, lsst::afw::geom::Transform< Point2Endpoint, Point2Endpoint >, lsst::afw::geom::Transform< Point2Endpoint, SpherePointEndpoint >, lsst::afw::geom::Transform< Point2Endpoint, SpherePointEndpoint >, lsst::afw::image::ApCorrMap, lsst::afw::image::CoaddInputs, lsst::afw::image::FilterLabel, lsst::afw::image::PhotoCalib, lsst::afw::image::VisitInfo, lsst::afw::math::AnalyticKernel, lsst::afw::math::BilinearWarpingKernel, lsst::afw::math::Chebyshev1Function2< ReturnT >, lsst::afw::math::ChebyshevBoundedField, lsst::afw::math::DeltaFunctionKernel, lsst::afw::math::DoubleGaussianFunction2< ReturnT >, lsst::afw::math::FixedKernel, lsst::afw::math::GaussianFunction2< ReturnT >, lsst::afw::math::LanczosWarpingKernel, lsst::afw::math::LinearCombinationKernel, lsst::afw::math::NearestWarpingKernel, lsst::afw::math::PixelAreaBoundedField, lsst::afw::math::PolynomialFunction2< ReturnT >, lsst::afw::math::ProductBoundedField, lsst::afw::math::TransformBoundedField, lsst::afw::math::WarpingControl, lsst::afw::typehandling::StorableHelper< Base >, lsst::meas::algorithms::CoaddBoundedField, lsst::meas::algorithms::CoaddPsf, lsst::meas::algorithms::DoubleGaussianPsf, lsst::meas::algorithms::KernelPsf, lsst::meas::algorithms::SingleGaussianPsf, lsst::meas::algorithms::WarpedPsf, lsst::meas::extensions::psfex::PsfexPsf, and lsst::meas::modelfit::Mixture.

Definition at line 102 of file Persistable.h.

{ return false; }

makeCameraSys() [1/2]

CameraSys lsst::afw::cameraGeom::DetectorBase::makeCameraSys ( CameraSys const & cameraSys ) const

inline

Get a coordinate system from a coordinate system (return input unchanged and untested)

Parameters

[in]

cameraSys

Camera coordinate system

Returns

cameraSys unchanged

Note

the CameraSysPrefix version needs the detector name, which is why this is not static.

Definition at line 110 of file Detector.h.

{ return cameraSys; }

makeCameraSys() [2/2]

CameraSys lsst::afw::cameraGeom::DetectorBase::makeCameraSys ( CameraSysPrefix const & cameraSysPrefix ) const

inline

Get a coordinate system from a detector system prefix (add detector name)

Parameters

[in]

cameraSysPrefix

Camera coordinate system prefix

Returns

cameraSysPrefix with the detector name added

Definition at line 118 of file Detector.h.

                                                                          {
        return CameraSys(cameraSysPrefix, getFields().name);
    }

operator=() [1/2]

DetectorBase & lsst::afw::cameraGeom::DetectorBase::operator= ( DetectorBase && )

protecteddefault

operator=() [2/2]

DetectorBase & lsst::afw::cameraGeom::DetectorBase::operator= ( DetectorBase const & )

protecteddefault

singleClassEquals()

template<class T>

static bool lsst::afw::typehandling::Storable::singleClassEquals ( T const & lhs, Storable const & rhs )

inlinestaticprotectedinherited

Test if a Storable is of a particular class and equal to another object.

This method template simplifies implementations of equals that delegate to operator== without supporting cross-class comparisons.

Template Parameters

T	The class expected of the two objects to be compared.

Parameters

lhs,rhs

The objects to compare. Note that rhs need not be a T, while lhs must be.

Returns

true if rhs is a T and lhs == rhs; false otherwise.

Exception Safety

Provides the same level of exception safety as operator==. Most implementations of operator== do not throw.

Note

This method template calls operator== with both arguments of compile-time type T const&. Its use is not recommended if there would be any ambiguity as to which operator== gets picked by overload resolution.

This method template is typically called from equals as:

bool MyType::equals(Storable const& other) const noexcept {
    return singleClassEquals(*this, other);
}

Definition at line 151 of file Storable.h.

                                                                     {
        auto typedRhs = dynamic_cast<T const*>(&rhs);
        if (typedRhs != nullptr) {
            return lhs == *typedRhs;
        } else {
            return false;
        }
    }

toString()

std::string lsst::afw::typehandling::Storable::toString ( ) const

virtualinherited

Create a string representation of this object (optional operation).

Exceptions

UnsupportedOperationException

Thrown if this object does not have a string representation.

Note

When called on Python classes, this method delegates to __repr__.

Reimplemented in lsst::afw::geom::polygon::Polygon, lsst::afw::geom::SkyWcs, lsst::afw::image::FilterLabel, lsst::afw::image::PhotoCalib, lsst::afw::image::VisitInfo, and lsst::afw::typehandling::StorableHelper< Base >.

Definition at line 40 of file Storable.cc.

                                   {
    throw LSST_EXCEPT(UnsupportedOperationException, "No string representation available.");
}

write()

void lsst::afw::table::io::Persistable::write ( OutputArchiveHandle & handle ) const

protectedvirtualinherited

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 in lsst::afw::cameraGeom::Camera, lsst::afw::cameraGeom::Detector, lsst::afw::cameraGeom::DetectorCollection, lsst::afw::cameraGeom::TransformMap, lsst::afw::detection::Footprint, lsst::afw::detection::GaussianPsf, lsst::afw::detection::HeavyFootprint< ImagePixelT, MaskPixelT, VariancePixelT >, lsst::afw::detection::HeavyFootprint< ImagePixelT, MaskPixelT, VariancePixelT >::Factory, lsst::afw::detection::HeavyFootprint< ImagePixelT, MaskPixelT, VariancePixelT >, lsst::afw::detection::HeavyFootprint< ImagePixelT, MaskPixelT, VariancePixelT >, lsst::afw::geom::polygon::Polygon, lsst::afw::geom::SkyWcs, lsst::afw::geom::SpanSet, lsst::afw::geom::Transform< FromEndpoint, ToEndpoint >, lsst::afw::geom::Transform< afw::geom::Point2Endpoint, afw::geom::GenericEndpoint >, lsst::afw::geom::Transform< afw::geom::Point2Endpoint, afw::geom::GenericEndpoint >, lsst::afw::geom::Transform< Point2Endpoint, GenericEndpoint >, lsst::afw::geom::Transform< Point2Endpoint, GenericEndpoint >, lsst::afw::geom::Transform< Point2Endpoint, Point2Endpoint >, lsst::afw::geom::Transform< Point2Endpoint, Point2Endpoint >, lsst::afw::geom::Transform< Point2Endpoint, SpherePointEndpoint >, lsst::afw::geom::Transform< Point2Endpoint, SpherePointEndpoint >, lsst::afw::image::ApCorrMap, lsst::afw::image::CoaddInputs, lsst::afw::image::FilterLabel, lsst::afw::image::PhotoCalib, lsst::afw::image::VisitInfo, lsst::afw::math::AnalyticKernel, lsst::afw::math::BilinearWarpingKernel, lsst::afw::math::Chebyshev1Function2< ReturnT >, lsst::afw::math::ChebyshevBoundedField, lsst::afw::math::DeltaFunctionKernel, lsst::afw::math::DoubleGaussianFunction2< ReturnT >, lsst::afw::math::FixedKernel, lsst::afw::math::GaussianFunction2< ReturnT >, lsst::afw::math::LanczosWarpingKernel, lsst::afw::math::LinearCombinationKernel, lsst::afw::math::NearestWarpingKernel, lsst::afw::math::PixelAreaBoundedField, lsst::afw::math::PolynomialFunction2< ReturnT >, lsst::afw::math::ProductBoundedField, lsst::afw::math::TransformBoundedField, lsst::afw::math::WarpingControl, lsst::afw::typehandling::StorableHelper< Base >, lsst::meas::algorithms::CoaddBoundedField, lsst::meas::algorithms::CoaddPsf, lsst::meas::algorithms::DoubleGaussianPsf, lsst::meas::algorithms::KernelPsf, lsst::meas::algorithms::SingleGaussianPsf, lsst::meas::algorithms::WarpedPsf, lsst::meas::extensions::psfex::PsfexPsf, and lsst::meas::modelfit::Mixture.

Definition at line 38 of file Persistable.cc.

                                                   {
    assert(!isPersistable());
    throw LSST_EXCEPT(pex::exceptions::LogicError,
                      "afw::table-based persistence is not supported for this object.");
}

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]

fitsfile

Open FITS object to write to.

Definition at line 18 of file Persistable.cc.

                                                    {
    OutputArchive archive;
    archive.put(this);
    archive.writeFits(fitsfile);
}

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]	manager	Name of the file to write to.
[in]	mode	If "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.

                                                                                    {
    fits::Fits fitsfile(manager, mode, fits::Fits::AUTO_CLOSE | fits::Fits::AUTO_CHECK);
    writeFits(fitsfile);
}

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]	fileName	Name of the file to write to.
[in]	mode	If "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.

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

Friends And Related Symbol Documentation

operator<<()

std::ostream & operator<< ( std::ostream & os, Storable const & storable )

related

Output operator for Storable.

Parameters

os	the desired output stream
storable	the object to print

Returns

a reference to os

Exceptions

UnsupportedOperationException

Thrown if storable does not have an implementation of Storable::toString.

Definition at line 174 of file Storable.h.

                                                                        {
    return os << storable.toString();
}

---

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

• /j/snowflake/release/lsstsw/stack/lsst-scipipe-12.1.0/Linux/afw/g7ae74a0b1c+a25e60b391/include/lsst/afw/cameraGeom/Detector.h