lsst::afw::image Namespace Reference

Backwards-compatibility support for depersisting the old Calib (FluxMag0/FluxMag0Err) objects. More...

Namespaces
	apCorrMap
	basicUtils
	detail
	details
	disableArithmetic
	exposure
	image
	maskedImage
	pixel
	python
	readMetadata
	SdssFilters
	slicing
	testUtils
	utils

Classes
class	ApCorrMap
	A thin wrapper around std::map to allow aperture corrections to be attached to Exposures. More...
class	CheckIndices
	A class used to request that array accesses be checked. More...
class	CoaddInputs
	A simple Persistable struct containing ExposureCatalogs that record the inputs to a coadd. More...
class	Color
	Describe the colour of a source. More...
struct	ConstReference
	metafunction to extract const reference type from PixelT More...
class	DecoratedImage
	A container for an Image and its associated metadata. More...
class	DefectBase
	Encapsulate information about a bad portion of a detector. More...
class	Exposure
	A class to contain the data, WCS, and other information needed to describe an image of the sky. More...
class	ExposureFitsReader
	A FITS reader class for Exposures and their components. More...
class	ExposureInfo
	A collection of all the things that make an Exposure different from a MaskedImage. More...
class	Filter
	Holds an integer identifier for an LSST filter. More...
class	FilterProperty
	Describe the properties of a Filter (e.g. More...
struct	GetImage
class	Image
	A class to represent a 2-dimensional array of pixels. More...
class	ImageBase
	The base class for all image classed (Image, Mask, MaskedImage, ...) More...
class	ImageBaseFitsReader
	Base class for image FITS readers. More...
class	ImageFitsReader
	A FITS reader class for regular Images. More...
class	imageIterator
	An ImageBase iterator. More...
class	imageLocator
	An ImageBase locator. More...
class	ImagePca
class	ImageSlice
	A class to specify a slice of an image. More...
class	Mask
	Represent a 2-dimensional array of bitmask pixels. More...
class	MaskedImage
	A class to manipulate images, masks, and variance as a single object. More...
class	MaskedImageFitsReader
	A FITS reader class for MaskedImages and their components. More...
class	MaskFitsReader
	A FITS reader class for Masks. More...
struct	Measurement
	A value and its error. More...
class	PhotoCalib
	The photometric calibration of an exposure. More...
struct	pixelOp0
	A functor class equivalent to std::function<ValT ()>, but with a virtual operator() More...
struct	pixelOp1
	A functor class equivalent to std::function<ValT (ValT)>, but with a virtual operator() More...
struct	pixelOp1XY
	A functor class equivalent to std::function<ValT (int, int, ValT)>, but with a virtual operator() More...
struct	pixelOp2
	A functor class equivalent to std::function<LhsT (LhsT, RhsT)>, but with a virtual operator() More...
struct	pixelOp2XY
	A functor class equivalent to std::function<LhsT (int, int, LhsT, RhsT)>, but with a virtual operator() More...
struct	Reference
	metafunction to extract reference type from PixelT More...
class	TransmissionCurve
	A spatially-varying transmission curve as a function of wavelength. More...
class	VisitInfo
	Information about a single exposure of an imaging camera. More...

Typedefs
typedef std::int32_t	MaskPixel
	default type for Masks and MaskedImage Masks More...
typedef float	VariancePixel
	default type for MaskedImage variance images More...

Enumerations
enum	ImageOrigin { PARENT, LOCAL }
enum	xOrY { X, Y }
enum	RotType { RotType::UNKNOWN, RotType::SKY, RotType::HORIZON, RotType::MOUNT }
	Type of rotation. More...

Functions
double	abMagFromFlux (double flux)
	Compute AB magnitude from flux in Janskys. More...
double	abMagErrFromFluxErr (double fluxErr, double flux)
	Compute AB magnitude error from flux and flux error in Janskys. More...
double	fluxFromABMag (double mag) noexcept
	Compute flux in Janskys from AB magnitude. More...
double	fluxErrFromABMagErr (double magErr, double mag) noexcept
	Compute flux error in Janskys from AB magnitude error and AB magnitude. More...
template<typename T >
ndarray::Array< T, 1 >	abMagFromFlux (ndarray::Array< T const, 1 > const &flux)
	Compute AB magnitude from flux in Janskys. More...
template<typename T >
ndarray::Array< T, 1 >	abMagErrFromFluxErr (ndarray::Array< T const, 1 > const &fluxErr, ndarray::Array< T const, 1 > const &flux)
	Compute AB magnitude error from flux and flux error in Janskys. More...
template<typename T >
ndarray::Array< T, 1 >	fluxFromABMag (ndarray::Array< T const, 1 > const &mag)
	Compute flux in Janskys from AB magnitude. More...
template<typename T >
ndarray::Array< T, 1 >	fluxErrFromABMagErr (ndarray::Array< T const, 1 > const &magErr, ndarray::Array< T const, 1 > const &mag)
	Compute flux error in Janskys from AB magnitude error and AB magnitude. More...
template<typename ImagePixelT , typename MaskPixelT , typename VariancePixelT >
std::shared_ptr< Exposure< ImagePixelT, MaskPixelT, VariancePixelT > >	makeExposure (MaskedImage< ImagePixelT, MaskPixelT, VariancePixelT > &mimage, std::shared_ptr< geom::SkyWcs const > wcs=std::shared_ptr< geom::SkyWcs const >())
	A function to return an Exposure of the correct type (cf. More...
template<typename LhsPixelT , typename RhsPixelT >
Image< LhsPixelT > &	operator+= (Image< LhsPixelT > &lhs, Image< RhsPixelT > const &rhs)
	Add lhs to Image rhs (i.e. pixel-by-pixel addition) where types are different. More...
template<typename LhsPixelT , typename RhsPixelT >
Image< LhsPixelT > &	operator-= (Image< LhsPixelT > &lhs, Image< RhsPixelT > const &rhs)
	Subtract lhs from Image rhs (i.e. pixel-by-pixel subtraction) where types are different. More...
template<typename LhsPixelT , typename RhsPixelT >
Image< LhsPixelT > &	operator*= (Image< LhsPixelT > &lhs, Image< RhsPixelT > const &rhs)
	Multiply lhs by Image rhs (i.e. pixel-by-pixel multiplication) where types are different. More...
template<typename LhsPixelT , typename RhsPixelT >
Image< LhsPixelT > &	operator/= (Image< LhsPixelT > &lhs, Image< RhsPixelT > const &rhs)
	Divide lhs by Image rhs (i.e. pixel-by-pixel division) where types are different. More...
template<typename PixelT >
void	swap (Image< PixelT > &a, Image< PixelT > &b)
template<typename PixelT >
void	swap (DecoratedImage< PixelT > &a, DecoratedImage< PixelT > &b)
lsst::geom::Box2I	bboxFromMetadata (daf::base::PropertySet &metadata)
	Determine the image bounding box from its metadata (FITS header) More...
template<typename T1 , typename T2 >
bool	imagesOverlap (ImageBase< T1 > const &image1, ImageBase< T2 > const &image2)
	Return true if the pixels for two images or masks overlap in memory. More...
template<typename LhsT >
void	for_each_pixel (Image< LhsT > &lhs, pixelOp0< LhsT > const &func)
	Set each pixel in an Image<LhsT> to func() More...
template<typename LhsT >
void	for_each_pixel (Image< LhsT > &lhs, pixelOp1< LhsT > const &func)
	Set each pixel in an Image<LhsT> to func(lhs) More...
template<typename LhsT >
void	for_each_pixel (Image< LhsT > &lhs, pixelOp1XY< LhsT > const &func)
	Set each pixel in an Image<LhsT> to func(x, y, lhs) More...
template<typename LhsT , typename RhsT >
void	for_each_pixel (Image< LhsT > &lhs, Image< RhsT > const &rhs, pixelOp1< RhsT > const &func)
	Set each pixel in an Image<LhsT> to func(rhs), getting the rhs from an Image<RhsT> More...
template<typename LhsT , typename RhsT >
void	for_each_pixel (Image< LhsT > &lhs, Image< RhsT > const &rhs, pixelOp2< LhsT, RhsT > const &func)
	Set each pixel in an Image<LhsT> to func(lhs, rhs), getting the rhs from an Image<RhsT> More...
template<typename LhsT , typename RhsT >
void	for_each_pixel (Image< LhsT > &lhs, Image< RhsT > const &rhs, pixelOp2XY< LhsT, RhsT > const &func)
	Set each pixel in an Image<LhsT> to func(x, y, lhs, rhs), getting the rhs from an Image<RhsT> More...
template<typename PixelT >
void	swap (ImageBase< PixelT > &a, ImageBase< PixelT > &b)
template<typename Image1T , typename Image2T >
double	innerProduct (Image1T const &lhs, Image2T const &rhs, int const border=0)
	Calculate the inner product of two images. More...
template<typename PixelT >
std::shared_ptr< Image< PixelT > >	operator+ (Image< PixelT > const &img, ImageSlice< PixelT > const &slc)
	Overload operator+() More...
template<typename PixelT >
std::shared_ptr< Image< PixelT > >	operator+ (ImageSlice< PixelT > const &slc, Image< PixelT > const &img)
	Overload operator+() More...
template<typename PixelT >
void	operator+= (Image< PixelT > &img, ImageSlice< PixelT > const &slc)
	Overload operator+=() More...
template<typename PixelT >
std::shared_ptr< Image< PixelT > >	operator- (Image< PixelT > const &img, ImageSlice< PixelT > const &slc)
	Overload operator-() More...
template<typename PixelT >
void	operator-= (Image< PixelT > &img, ImageSlice< PixelT > const &slc)
	Overload operator-=() More...
template<typename PixelT >
std::shared_ptr< Image< PixelT > >	operator* (Image< PixelT > const &img, ImageSlice< PixelT > const &slc)
	Overload operator*() More...
template<typename PixelT >
std::shared_ptr< Image< PixelT > >	operator* (ImageSlice< PixelT > const &slc, Image< PixelT > const &img)
	Overload operator*() More...
template<typename PixelT >
void	operator*= (Image< PixelT > &img, ImageSlice< PixelT > const &slc)
	Overload operator*=() More...
template<typename PixelT >
std::shared_ptr< Image< PixelT > >	operator/ (Image< PixelT > const &img, ImageSlice< PixelT > const &slc)
	Overload operator/() More...
template<typename PixelT >
void	operator/= (Image< PixelT > &img, ImageSlice< PixelT > const &slc)
	Overload operator/=() More...
double	indexToPosition (double ind)
	Convert image index to image position. More...
int	positionToIndex (double pos)
	Convert image position to nearest integer index. More...
int	positionToIndex (double &residual, double pos)
	Convert image position to index (nearest integer and fractional parts) More...
std::pair< int, double >	positionToIndex (double const pos, bool)
	Convert image position to index (nearest integer and fractional parts) More...
template<typename PixelT >
void	swap (Mask< PixelT > &a, Mask< PixelT > &b)
template<typename ImagePixelT , typename MaskPixelT , typename VariancePixelT >
MaskedImage< ImagePixelT, MaskPixelT, VariancePixelT > *	makeMaskedImage (typename std::shared_ptr< Image< ImagePixelT >> image, typename std::shared_ptr< Mask< MaskPixelT >> mask=Mask< MaskPixelT >(), typename std::shared_ptr< Image< VariancePixelT >> variance=Image< VariancePixelT >())
	A function to return a MaskedImage of the correct type (cf. More...
template<typename ImagePixelT1 , typename ImagePixelT2 >
bool	imagesOverlap (MaskedImage< ImagePixelT1, MaskPixel, VariancePixel > const &image1, MaskedImage< ImagePixelT2, MaskPixel, VariancePixel > const &image2)
	Return true if the pixels for two masked images (image, variance or mask plane) overlap in memory. More...
std::ostream &	operator<< (std::ostream &os, Measurement const &measurement)
void	assertNonNegative (double value, std::string const &name)
	Raise lsst::pex::exceptions::InvalidParameterError if value is not >=0. More...
std::shared_ptr< PhotoCalib >	makePhotoCalibFromMetadata (daf::base::PropertySet &metadata, bool strip=false)
	Construct a PhotoCalib from FITS FLUXMAG0/FLUXMAG0ERR keywords. More...
std::shared_ptr< PhotoCalib >	makePhotoCalibFromCalibZeroPoint (double instFluxMag0, double instFluxMag0Err)
	Construct a PhotoCalib from the deprecated Calib-style instFluxMag0/instFluxMag0Err values. More...
std::shared_ptr< daf::base::PropertyList >	readMetadata (std::string const &fileName, int hdu=fits::DEFAULT_HDU, bool strip=false)
	Return the metadata (header entries) from a FITS file. More...
template<typename ImageT >
ImageT::SinglePixel	badPixel (typename ImageT::Pixel bad=0)
	Return a value indicating a bad pixel for the given Image type. More...
std::ostream &	operator<< (std::ostream &os, VisitInfo const &visitInfo)
	PYBIND11_MODULE (imagePca, mod)
	PYBIND11_MODULE (maskedImage, mod)
	PYBIND11_MODULE (readMetadata, mod)
	PYBIND11_MODULE (visitInfo, mod)
template ndarray::Array< float, 1 >	abMagFromFlux (ndarray::Array< float const, 1 > const &flux)
template ndarray::Array< float, 1 >	abMagErrFromFluxErr (ndarray::Array< float const, 1 > const &fluxErr, ndarray::Array< float const, 1 > const &flux)
template ndarray::Array< float, 1 >	fluxFromABMag (ndarray::Array< float const, 1 > const &mag)
template ndarray::Array< float, 1 >	fluxErrFromABMagErr (ndarray::Array< float const, 1 > const &magErr, ndarray::Array< float const, 1 > const &mag)
template ndarray::Array< double, 1 >	abMagFromFlux (ndarray::Array< double const, 1 > const &flux)
template ndarray::Array< double, 1 >	abMagErrFromFluxErr (ndarray::Array< double const, 1 > const &fluxErr, ndarray::Array< double const, 1 > const &flux)
template ndarray::Array< double, 1 >	fluxFromABMag (ndarray::Array< double const, 1 > const &mag)
template ndarray::Array< double, 1 >	fluxErrFromABMagErr (ndarray::Array< double const, 1 > const &magErr, ndarray::Array< double const, 1 > const &mag)
template bool	imagesOverlap< std::uint16_t, std::uint16_t > (MaskedImage< std::uint16_t > const &, MaskedImage< std::uint16_t > const &)
template bool	imagesOverlap< std::uint16_t, int > (MaskedImage< std::uint16_t > const &, MaskedImage< int > const &)
template bool	imagesOverlap< std::uint16_t, float > (MaskedImage< std::uint16_t > const &, MaskedImage< float > const &)
template bool	imagesOverlap< std::uint16_t, double > (MaskedImage< std::uint16_t > const &, MaskedImage< double > const &)
template bool	imagesOverlap< std::uint16_t, std::uint64_t > (MaskedImage< std::uint16_t > const &, MaskedImage< std::uint64_t > const &)
template bool	imagesOverlap< int, std::uint16_t > (MaskedImage< int > const &, MaskedImage< std::uint16_t > const &)
template bool	imagesOverlap< int, int > (MaskedImage< int > const &, MaskedImage< int > const &)
template bool	imagesOverlap< int, float > (MaskedImage< int > const &, MaskedImage< float > const &)
template bool	imagesOverlap< int, double > (MaskedImage< int > const &, MaskedImage< double > const &)
template bool	imagesOverlap< int, std::uint64_t > (MaskedImage< int > const &, MaskedImage< std::uint64_t > const &)
template bool	imagesOverlap< float, std::uint16_t > (MaskedImage< float > const &, MaskedImage< std::uint16_t > const &)
template bool	imagesOverlap< float, int > (MaskedImage< float > const &, MaskedImage< int > const &)
template bool	imagesOverlap< float, float > (MaskedImage< float > const &, MaskedImage< float > const &)
template bool	imagesOverlap< float, double > (MaskedImage< float > const &, MaskedImage< double > const &)
template bool	imagesOverlap< float, std::uint64_t > (MaskedImage< float > const &, MaskedImage< std::uint64_t > const &)
template bool	imagesOverlap< double, std::uint16_t > (MaskedImage< double > const &, MaskedImage< std::uint16_t > const &)
template bool	imagesOverlap< double, int > (MaskedImage< double > const &, MaskedImage< int > const &)
template bool	imagesOverlap< double, float > (MaskedImage< double > const &, MaskedImage< float > const &)
template bool	imagesOverlap< double, double > (MaskedImage< double > const &, MaskedImage< double > const &)
template bool	imagesOverlap< double, std::uint64_t > (MaskedImage< double > const &, MaskedImage< std::uint64_t > const &)
template bool	imagesOverlap< std::uint64_t, std::uint16_t > (MaskedImage< std::uint64_t > const &, MaskedImage< std::uint16_t > const &)
template bool	imagesOverlap< std::uint64_t, int > (MaskedImage< std::uint64_t > const &, MaskedImage< int > const &)
template bool	imagesOverlap< std::uint64_t, float > (MaskedImage< std::uint64_t > const &, MaskedImage< float > const &)
template bool	imagesOverlap< std::uint64_t, double > (MaskedImage< std::uint64_t > const &, MaskedImage< double > const &)
template bool	imagesOverlap< std::uint64_t, std::uint64_t > (MaskedImage< std::uint64_t > const &, MaskedImage< std::uint64_t > const &)
std::ostream &	operator<< (std::ostream &os, PhotoCalib const &photoCalib)

Variables
const double	PixelZeroPos = 0.0
	position of center of pixel 0 More...

Detailed Description

Backwards-compatibility support for depersisting the old Calib (FluxMag0/FluxMag0Err) objects.

Typedef Documentation

MaskPixel

typedef std::int32_t lsst::afw::image::MaskPixel

default type for Masks and MaskedImage Masks

Definition at line 34 of file LsstImageTypes.h.

VariancePixel

typedef float lsst::afw::image::VariancePixel

default type for MaskedImage variance images

Definition at line 35 of file LsstImageTypes.h.

Enumeration Type Documentation

ImageOrigin

enum lsst::afw::image::ImageOrigin

Enumerator
PARENT
LOCAL

Definition at line 94 of file ImageBase.h.

{ PARENT, LOCAL };

RotType

enum lsst::afw::image::RotType

strong

Type of rotation.

Enumerator
UNKNOWN	Rotation angle is unknown. Note: if there is no instrument rotator then it is better to compute SKY or HORIZON and use that rotation type rather than specify UNKNOWN.
SKY	Position angle of focal plane +Y, measured from N through E. At 0 degrees, +Y is along N and +X is along E/W depending on handedness. At 90 degrees, +Y is along E and +X is along S/N depending on handedness.
HORIZON	Position angle of focal plane +Y, measured from +Alt through +Az. At 0 degrees, +Y is along +Alt and +X is along +/-Az, depending on handedness. At 90 degrees, +Y is along +Az and +X is along -/+Alt, depending on handedness.
MOUNT	The position sent to the instrument rotator; the details depend on the rotator.

Definition at line 45 of file VisitInfo.h.

                   {
    UNKNOWN,  
    SKY,      
    HORIZON,  
    MOUNT     
};

xOrY

enum lsst::afw::image::xOrY

Enumerator
X
Y

Definition at line 36 of file ImageUtils.h.

{ X, Y };

Function Documentation

abMagErrFromFluxErr() [1/4]

double lsst::afw::image::abMagErrFromFluxErr ( double  fluxErr, double  flux  )

inline

Compute AB magnitude error from flux and flux error in Janskys.

Definition at line 52 of file Calib.h.

                                                               {
    return std::abs(fluxErr / (-0.4 * flux * std::log(10)));
}

abMagErrFromFluxErr() [2/4]

template ndarray::Array< double , 1> lsst::afw::image::abMagErrFromFluxErr	(	ndarray::Array< double const, 1 > const &	fluxErr,
		ndarray::Array< double const, 1 > const &	flux
	)

abMagErrFromFluxErr() [3/4]

template ndarray::Array< float , 1> lsst::afw::image::abMagErrFromFluxErr	(	ndarray::Array< float const, 1 > const &	fluxErr,
		ndarray::Array< float const, 1 > const &	flux
	)

abMagErrFromFluxErr() [4/4]

template<typename T >

ndarray::Array< T, 1 > lsst::afw::image::abMagErrFromFluxErr	(	ndarray::Array< T const, 1 > const &	fluxErr,
		ndarray::Array< T const, 1 > const &	flux
	)

Compute AB magnitude error from flux and flux error in Janskys.

Definition at line 52 of file Calib.cc.

                                                                               {
    if (flux.getNumElements() != fluxErr.getNumElements()) {
        throw LSST_EXCEPT(pex::exceptions::LengthError, (boost::format("Length mismatch: %d vs %d") %
                                                         flux.getNumElements() % fluxErr.getNumElements())
                                                                .str());
    }
    ndarray::Array<T, 1> out = ndarray::allocate(flux.getShape());
    for (std::size_t ii = 0; ii < flux.getNumElements(); ++ii) {
        out[ii] = abMagErrFromFluxErr(fluxErr[ii], flux[ii]);
    }
    return out;
}

abMagFromFlux() [1/4]

double lsst::afw::image::abMagFromFlux ( double  flux )

inline

Compute AB magnitude from flux in Janskys.

Definition at line 49 of file Calib.h.

{ return -2.5 * std::log10(flux / JanskysPerABFlux); }

abMagFromFlux() [2/4]

template ndarray::Array< double , 1> lsst::afw::image::abMagFromFlux

(

ndarray::Array< double const, 1 > const &

flux

)

abMagFromFlux() [3/4]

template ndarray::Array< float , 1> lsst::afw::image::abMagFromFlux

(

ndarray::Array< float const, 1 > const &

flux

)

abMagFromFlux() [4/4]

template<typename T >

ndarray::Array< T, 1 > lsst::afw::image::abMagFromFlux

(

ndarray::Array< T const, 1 > const &

flux

)

Compute AB magnitude from flux in Janskys.

Definition at line 42 of file Calib.cc.

                                                                       {
    ndarray::Array<T, 1> out = ndarray::allocate(flux.getShape());
    for (std::size_t ii = 0; ii < flux.getNumElements(); ++ii) {
        out[ii] = abMagFromFlux(flux[ii]);
    }
    return out;
}

assertNonNegative()

void lsst::afw::image::assertNonNegative ( double  value, std::string const &  name  )

inline

Raise lsst::pex::exceptions::InvalidParameterError if value is not >=0.

Used for checking the calibration mean/error in the constructor.

Parameters

value	Value that should be positive.
name	Text to prepend to error message.

Exceptions

lsst::pex::exceptions::InvalidParameterError

if value < 0

Definition at line 69 of file PhotoCalib.h.

                                                                   {
    if (value < 0) {
        throw LSST_EXCEPT(lsst::pex::exceptions::InvalidParameterError,
                          (boost::format("%s must be positive: %.3g") % name % value).str());
    }
}

badPixel()

template<typename ImageT >

ImageT::SinglePixel badPixel

(

typename ImageT::Pixel

bad = 0

)

Return a value indicating a bad pixel for the given Image type.

A quiet NaN is returned for types that support it otherwise bad

Parameters

bad	The bad value if NaN isn't supported

Definition at line 77 of file Utils.h.

  {
    typedef typename ImageT::SinglePixel SinglePixelT;
    return SinglePixelT(std::numeric_limits<SinglePixelT>::has_quiet_NaN
                                ? std::numeric_limits<SinglePixelT>::quiet_NaN()
                                : bad);
}

bboxFromMetadata()

lsst::geom::Box2I lsst::afw::image::bboxFromMetadata

(

daf::base::PropertySet &

metadata

)

Determine the image bounding box from its metadata (FITS header)

Note that this modifies the metadata, stripping the WCS headers that provide the xy0.

Definition at line 694 of file Image.cc.

                                                             {
    lsst::geom::Extent2I dims;
    if (metadata.exists("ZNAXIS1") && metadata.exists("ZNAXIS2")) {
        dims = lsst::geom::Extent2I(metadata.getAsInt("ZNAXIS1"), metadata.getAsInt("ZNAXIS2"));
    } else {
        dims = lsst::geom::Extent2I(metadata.getAsInt("NAXIS1"), metadata.getAsInt("NAXIS2"));
    }
    lsst::geom::Point2I xy0 = geom::getImageXY0FromMetadata(metadata, detail::wcsNameForXY0);
    return lsst::geom::Box2I(xy0, dims);
}

fluxErrFromABMagErr() [1/4]

double lsst::afw::image::fluxErrFromABMagErr ( double  magErr, double  mag  )

inlinenoexcept

Compute flux error in Janskys from AB magnitude error and AB magnitude.

Definition at line 60 of file Calib.h.

                                                                      {
    return std::abs(-0.4 * magErr * fluxFromABMag(mag) * std::log(10.0));
}

fluxErrFromABMagErr() [2/4]

template ndarray::Array< double , 1> lsst::afw::image::fluxErrFromABMagErr	(	ndarray::Array< double const, 1 > const &	magErr,
		ndarray::Array< double const, 1 > const &	mag
	)

fluxErrFromABMagErr() [3/4]

template ndarray::Array< float , 1> lsst::afw::image::fluxErrFromABMagErr	(	ndarray::Array< float const, 1 > const &	magErr,
		ndarray::Array< float const, 1 > const &	mag
	)

fluxErrFromABMagErr() [4/4]

template<typename T >

ndarray::Array< T, 1 > lsst::afw::image::fluxErrFromABMagErr	(	ndarray::Array< T const, 1 > const &	magErr,
		ndarray::Array< T const, 1 > const &	mag
	)

Compute flux error in Janskys from AB magnitude error and AB magnitude.

Definition at line 78 of file Calib.cc.

                                                                              {
    if (mag.getNumElements() != magErr.getNumElements()) {
        throw LSST_EXCEPT(pex::exceptions::LengthError, (boost::format("Length mismatch: %d vs %d") %
                                                         mag.getNumElements() % magErr.getNumElements())
                                                                .str());
    }
    ndarray::Array<T, 1> out = ndarray::allocate(mag.getShape());
    for (std::size_t ii = 0; ii < mag.getNumElements(); ++ii) {
        out[ii] = fluxErrFromABMagErr(magErr[ii], mag[ii]);
    }
    return out;
}

fluxFromABMag() [1/4]

double lsst::afw::image::fluxFromABMag ( double  mag )

inlinenoexcept

Compute flux in Janskys from AB magnitude.

Definition at line 57 of file Calib.h.

{ return std::pow(10.0, -0.4 * mag) * JanskysPerABFlux; }

fluxFromABMag() [2/4]

template ndarray::Array< double , 1> lsst::afw::image::fluxFromABMag

(

ndarray::Array< double const, 1 > const &

mag

)

fluxFromABMag() [3/4]

template ndarray::Array< float , 1> lsst::afw::image::fluxFromABMag

(

ndarray::Array< float const, 1 > const &

mag

)

fluxFromABMag() [4/4]

template<typename T >

ndarray::Array< T, 1 > lsst::afw::image::fluxFromABMag

(

ndarray::Array< T const, 1 > const &

mag

)

Compute flux in Janskys from AB magnitude.

Definition at line 68 of file Calib.cc.

                                                                      {
    ndarray::Array<T, 1> out = ndarray::allocate(mag.getShape());
    for (std::size_t ii = 0; ii < mag.getNumElements(); ++ii) {
        out[ii] = fluxFromABMag(mag[ii]);
    }
    return out;
}

for_each_pixel() [1/6]

template<typename LhsT , typename RhsT >

void lsst::afw::image::for_each_pixel	(	Image< LhsT > &	lhs,
		Image< RhsT > const &	rhs,
		pixelOp1< RhsT > const &	func
	)

Set each pixel in an Image<LhsT> to func(rhs), getting the rhs from an Image<RhsT>

Parameters

lhs	Image to set
rhs	other Image to pass to `func`
func	functor to call

Definition at line 145 of file ImageAlgorithm.h.

  {
    if (lhs.getDimensions() != rhs.getDimensions()) {
        throw LSST_EXCEPT(lsst::pex::exceptions::LengthError,
                          (boost::format("Images are of different size, %dx%d v %dx%d") % lhs.getWidth() %
                           lhs.getHeight() % rhs.getWidth() % rhs.getHeight())
                                  .str());
    }
 
    for (int y = 0; y != lhs.getHeight(); ++y) {
        typename Image<RhsT>::const_x_iterator rhsPtr = rhs.row_begin(y);
 
        for (typename Image<LhsT>::x_iterator lhsPtr = lhs.row_begin(y), lhsEnd = lhs.row_end(y);
             lhsPtr != lhsEnd; ++rhsPtr, ++lhsPtr) {
            *lhsPtr = func(*rhsPtr);
        }
    }
}

for_each_pixel() [2/6]

template<typename LhsT , typename RhsT >

void lsst::afw::image::for_each_pixel	(	Image< LhsT > &	lhs,
		Image< RhsT > const &	rhs,
		pixelOp2< LhsT, RhsT > const &	func
	)

Set each pixel in an Image<LhsT> to func(lhs, rhs), getting the rhs from an Image<RhsT>

Parameters

lhs	Image to set
rhs	other Image to pass to `func`
func	functor to call

Definition at line 170 of file ImageAlgorithm.h.

  {
    if (lhs.getDimensions() != rhs.getDimensions()) {
        throw LSST_EXCEPT(lsst::pex::exceptions::LengthError,
                          (boost::format("Images are of different size, %dx%d v %dx%d") % lhs.getWidth() %
                           lhs.getHeight() % rhs.getWidth() % rhs.getHeight())
                                  .str());
    }
 
    for (int y = 0; y != lhs.getHeight(); ++y) {
        typename Image<RhsT>::const_x_iterator rhsPtr = rhs.row_begin(y);
 
        for (typename Image<LhsT>::x_iterator lhsPtr = lhs.row_begin(y), lhsEnd = lhs.row_end(y);
             lhsPtr != lhsEnd; ++rhsPtr, ++lhsPtr) {
            *lhsPtr = func(*lhsPtr, *rhsPtr);
        }
    }
}

for_each_pixel() [3/6]

template<typename LhsT , typename RhsT >

void lsst::afw::image::for_each_pixel	(	Image< LhsT > &	lhs,
		Image< RhsT > const &	rhs,
		pixelOp2XY< LhsT, RhsT > const &	func
	)

Set each pixel in an Image<LhsT> to func(x, y, lhs, rhs), getting the rhs from an Image<RhsT>

(x, y) allow for lhs.getXY0()

Parameters

lhs	Image to set
rhs	other Image to pass to `func`
func	functor to call

Definition at line 196 of file ImageAlgorithm.h.

  {
    if (lhs.getDimensions() != rhs.getDimensions()) {
        throw LSST_EXCEPT(lsst::pex::exceptions::LengthError,
                          (boost::format("Images are of different size, %dx%d v %dx%d") % lhs.getWidth() %
                           lhs.getHeight() % rhs.getWidth() % rhs.getHeight())
                                  .str());
    }
 
    for (int y = 0; y != lhs.getHeight(); ++y) {
        typename Image<RhsT>::const_x_iterator rhsPtr = rhs.row_begin(y);
        int x = lhs.getX0();
        for (typename Image<LhsT>::x_iterator lhsPtr = lhs.row_begin(y), lhsEnd = lhs.row_end(y);
             lhsPtr != lhsEnd; ++rhsPtr, ++lhsPtr, ++x) {
            *lhsPtr = func(x, y + lhs.getY0(), *lhsPtr, *rhsPtr);
        }
    }
}

for_each_pixel() [4/6]

template<typename LhsT >

void lsst::afw::image::for_each_pixel	(	Image< LhsT > &	lhs,
		pixelOp0< LhsT > const &	func
	)

Set each pixel in an Image<LhsT> to func()

Parameters

lhs	Image to set
func	functor to call

Examples

forEachPixel.cc.

Definition at line 97 of file ImageAlgorithm.h.

  {
    for (int y = 0; y != lhs.getHeight(); ++y) {
        for (typename Image<LhsT>::x_iterator lhsPtr = lhs.row_begin(y), lhsEnd = lhs.row_end(y);
             lhsPtr != lhsEnd; ++lhsPtr) {
            *lhsPtr = func();
        }
    }
}

for_each_pixel() [5/6]

template<typename LhsT >

void lsst::afw::image::for_each_pixel	(	Image< LhsT > &	lhs,
		pixelOp1< LhsT > const &	func
	)

Set each pixel in an Image<LhsT> to func(lhs)

Parameters

lhs	Image to set
func	functor to call

Definition at line 112 of file ImageAlgorithm.h.

  {
    for (int y = 0; y != lhs.getHeight(); ++y) {
        for (typename Image<LhsT>::x_iterator lhsPtr = lhs.row_begin(y), lhsEnd = lhs.row_end(y);
             lhsPtr != lhsEnd; ++lhsPtr) {
            *lhsPtr = func(*lhsPtr);
        }
    }
}

for_each_pixel() [6/6]

template<typename LhsT >

void lsst::afw::image::for_each_pixel	(	Image< LhsT > &	lhs,
		pixelOp1XY< LhsT > const &	func
	)

Set each pixel in an Image<LhsT> to func(x, y, lhs)

(x, y) allow for lhs.getXY0()

Parameters

lhs	Image to set
func	functor to call

Definition at line 129 of file ImageAlgorithm.h.

  {
    for (int y = 0; y != lhs.getHeight(); ++y) {
        int x = lhs.getX0();
        for (typename Image<LhsT>::x_iterator lhsPtr = lhs.row_begin(y), lhsEnd = lhs.row_end(y);
             lhsPtr != lhsEnd; ++lhsPtr, ++x) {
            *lhsPtr = func(x, y + lhs.getY0(), *lhsPtr);
        }
    }
}

imagesOverlap() [1/2]

template<typename T1 , typename T2 >

bool lsst::afw::image::imagesOverlap	(	ImageBase< T1 > const &	image1,
		ImageBase< T2 > const &	image2
	)

Return true if the pixels for two images or masks overlap in memory.

Definition at line 706 of file Image.cc.

                                                                             {
    auto arr1 = image1.getArray();
    // get the address of the first and one-past-the-last element of arr1 using ndarray iterators;
    // this works because the iterators for contiguous 1-d ndarray Arrays are just pointers
    auto beg1Addr = arr1.front().begin();
    auto end1Addr = arr1.back().end();
 
    auto arr2 = image2.getArray();
    auto beg2Addr = arr2.front().begin();
    auto end2Addr = arr2.back().end();
 
    auto ptrLess = std::less<void const* const>();
    return ptrLess(beg1Addr, end2Addr) && ptrLess(beg2Addr, end1Addr);
}

imagesOverlap() [2/2]

template<typename ImagePixelT1 , typename ImagePixelT2 >

bool lsst::afw::image::imagesOverlap	(	MaskedImage< ImagePixelT1, MaskPixel, VariancePixel > const &	image1,
		MaskedImage< ImagePixelT2, MaskPixel, VariancePixel > const &	image2
	)

Return true if the pixels for two masked images (image, variance or mask plane) overlap in memory.

Definition at line 671 of file MaskedImage.cc.

                                                                                      {
    return imagesOverlap(*image1.getImage(), *image2.getImage()) ||
           imagesOverlap(*image1.getVariance(), *image2.getVariance()) ||
           imagesOverlap(*image1.getMask(), *image2.getMask());
}

imagesOverlap< double, double >()

template bool lsst::afw::image::imagesOverlap< double, double >	(	MaskedImage< double > const &	,
		MaskedImage< double > const &
	)

imagesOverlap< double, float >()

template bool lsst::afw::image::imagesOverlap< double, float >	(	MaskedImage< double > const &	,
		MaskedImage< float > const &
	)

imagesOverlap< double, int >()

template bool lsst::afw::image::imagesOverlap< double, int >	(	MaskedImage< double > const &	,
		MaskedImage< int > const &
	)

imagesOverlap< double, std::uint16_t >()

template bool lsst::afw::image::imagesOverlap< double, std::uint16_t >	(	MaskedImage< double > const &	,
		MaskedImage< std::uint16_t > const &
	)

imagesOverlap< double, std::uint64_t >()

template bool lsst::afw::image::imagesOverlap< double, std::uint64_t >	(	MaskedImage< double > const &	,
		MaskedImage< std::uint64_t > const &
	)

imagesOverlap< float, double >()

template bool lsst::afw::image::imagesOverlap< float, double >	(	MaskedImage< float > const &	,
		MaskedImage< double > const &
	)

imagesOverlap< float, float >()

template bool lsst::afw::image::imagesOverlap< float, float >	(	MaskedImage< float > const &	,
		MaskedImage< float > const &
	)

imagesOverlap< float, int >()

template bool lsst::afw::image::imagesOverlap< float, int >	(	MaskedImage< float > const &	,
		MaskedImage< int > const &
	)

imagesOverlap< float, std::uint16_t >()

template bool lsst::afw::image::imagesOverlap< float, std::uint16_t >	(	MaskedImage< float > const &	,
		MaskedImage< std::uint16_t > const &
	)

imagesOverlap< float, std::uint64_t >()

template bool lsst::afw::image::imagesOverlap< float, std::uint64_t >	(	MaskedImage< float > const &	,
		MaskedImage< std::uint64_t > const &
	)

imagesOverlap< int, double >()

template bool lsst::afw::image::imagesOverlap< int, double >	(	MaskedImage< int > const &	,
		MaskedImage< double > const &
	)

imagesOverlap< int, float >()

template bool lsst::afw::image::imagesOverlap< int, float >	(	MaskedImage< int > const &	,
		MaskedImage< float > const &
	)

imagesOverlap< int, int >()

template bool lsst::afw::image::imagesOverlap< int, int >	(	MaskedImage< int > const &	,
		MaskedImage< int > const &
	)

imagesOverlap< int, std::uint16_t >()

template bool lsst::afw::image::imagesOverlap< int, std::uint16_t >	(	MaskedImage< int > const &	,
		MaskedImage< std::uint16_t > const &
	)

imagesOverlap< int, std::uint64_t >()

template bool lsst::afw::image::imagesOverlap< int, std::uint64_t >	(	MaskedImage< int > const &	,
		MaskedImage< std::uint64_t > const &
	)

imagesOverlap< std::uint16_t, double >()

template bool lsst::afw::image::imagesOverlap< std::uint16_t, double >	(	MaskedImage< std::uint16_t > const &	,
		MaskedImage< double > const &
	)

imagesOverlap< std::uint16_t, float >()

template bool lsst::afw::image::imagesOverlap< std::uint16_t, float >	(	MaskedImage< std::uint16_t > const &	,
		MaskedImage< float > const &
	)

imagesOverlap< std::uint16_t, int >()

template bool lsst::afw::image::imagesOverlap< std::uint16_t, int >	(	MaskedImage< std::uint16_t > const &	,
		MaskedImage< int > const &
	)

imagesOverlap< std::uint16_t, std::uint16_t >()

template bool lsst::afw::image::imagesOverlap< std::uint16_t, std::uint16_t >	(	MaskedImage< std::uint16_t > const &	,
		MaskedImage< std::uint16_t > const &
	)

imagesOverlap< std::uint16_t, std::uint64_t >()

template bool lsst::afw::image::imagesOverlap< std::uint16_t, std::uint64_t >	(	MaskedImage< std::uint16_t > const &	,
		MaskedImage< std::uint64_t > const &
	)

imagesOverlap< std::uint64_t, double >()

template bool lsst::afw::image::imagesOverlap< std::uint64_t, double >	(	MaskedImage< std::uint64_t > const &	,
		MaskedImage< double > const &
	)

imagesOverlap< std::uint64_t, float >()

template bool lsst::afw::image::imagesOverlap< std::uint64_t, float >	(	MaskedImage< std::uint64_t > const &	,
		MaskedImage< float > const &
	)

imagesOverlap< std::uint64_t, int >()

template bool lsst::afw::image::imagesOverlap< std::uint64_t, int >	(	MaskedImage< std::uint64_t > const &	,
		MaskedImage< int > const &
	)

imagesOverlap< std::uint64_t, std::uint16_t >()

template bool lsst::afw::image::imagesOverlap< std::uint64_t, std::uint16_t >	(	MaskedImage< std::uint64_t > const &	,
		MaskedImage< std::uint16_t > const &
	)

imagesOverlap< std::uint64_t, std::uint64_t >()

template bool lsst::afw::image::imagesOverlap< std::uint64_t, std::uint64_t >	(	MaskedImage< std::uint64_t > const &	,
		MaskedImage< std::uint64_t > const &
	)

indexToPosition()

double lsst::afw::image::indexToPosition ( double  ind )

inline

Convert image index to image position.

The LSST indexing convention is:

• the index of the bottom left pixel is 0,0
• the position of the center of the bottom left pixel is PixelZeroPos, PixelZeroPos

Returns

image position

Parameters

ind	image index

Definition at line 55 of file ImageUtils.h.

  {
    return ind + PixelZeroPos;
}

innerProduct()

template<typename Image1T , typename Image2T >

double lsst::afw::image::innerProduct	(	Image1T const &	lhs,
		Image2T const &	rhs,
		int const	border = 0
	)

Calculate the inner product of two images.

Parameters

lhs	first image
rhs	Other image to dot with first
border	number of pixels to ignore around the edge

Returns

The inner product

Exceptions

lsst::pex::exceptions::LengthError

if all the images aren't the same size

Definition at line 415 of file ImagePca.cc.

                                                                        {
    if (lhs.getWidth() <= 2 * border || lhs.getHeight() <= 2 * border) {
        throw LSST_EXCEPT(lsst::pex::exceptions::LengthError,
                          (boost::format("All image pixels are in the border of width %d: %dx%d") % border %
                           lhs.getWidth() % lhs.getHeight())
                                  .str());
    }
 
    double sum = 0.0;
    //
    // Handle I.I specially for efficiency, and to avoid advancing the iterator twice
    //
    if (imagesAreIdentical(lhs, rhs)) {
        for (int y = border; y != lhs.getHeight() - border; ++y) {
            for (typename Image1T::const_x_iterator lptr = lhs.row_begin(y) + border,
                                                    lend = lhs.row_end(y) - border;
                 lptr != lend; ++lptr) {
                typename Image1T::Pixel val = *lptr;
                if (std::isfinite(val)) {
                    sum += val * val;
                }
            }
        }
    } else {
        if (lhs.getDimensions() != rhs.getDimensions()) {
            throw LSST_EXCEPT(lsst::pex::exceptions::LengthError,
                              (boost::format("Dimension mismatch: %dx%d v. %dx%d") % lhs.getWidth() %
                               lhs.getHeight() % rhs.getWidth() % rhs.getHeight())
                                      .str());
        }
 
        for (int y = border; y != lhs.getHeight() - border; ++y) {
            typename Image2T::const_x_iterator rptr = rhs.row_begin(y) + border;
            for (typename Image1T::const_x_iterator lptr = lhs.row_begin(y) + border,
                                                    lend = lhs.row_end(y) - border;
                 lptr != lend; ++lptr, ++rptr) {
                double const tmp = (*lptr) * (*rptr);
                if (std::isfinite(tmp)) {
                    sum += tmp;
                }
            }
        }
    }
 
    return sum;
}

makeExposure()

template<typename ImagePixelT , typename MaskPixelT , typename VariancePixelT >

std::shared_ptr<Exposure<ImagePixelT, MaskPixelT, VariancePixelT> > lsst::afw::image::makeExposure	(	MaskedImage< ImagePixelT, MaskPixelT, VariancePixelT > &	mimage,
		std::shared_ptr< geom::SkyWcs const >	wcs = std::shared_ptr<geom::SkyWcs const>()
	)

A function to return an Exposure of the correct type (cf.

std::make_pair)

Parameters

mimage	the Exposure's image
wcs	the Exposure's WCS

Definition at line 442 of file Exposure.h.

  {
    return typename std::shared_ptr<Exposure<ImagePixelT, MaskPixelT, VariancePixelT>>(
            new Exposure<ImagePixelT, MaskPixelT, VariancePixelT>(mimage, wcs));
}

makeMaskedImage()

template<typename ImagePixelT , typename MaskPixelT , typename VariancePixelT >

MaskedImage<ImagePixelT, MaskPixelT, VariancePixelT>* lsst::afw::image::makeMaskedImage	(	typename std::shared_ptr< Image< ImagePixelT >>	image,
		typename std::shared_ptr< Mask< MaskPixelT >>	mask = Mask<MaskPixelT>(),
		typename std::shared_ptr< Image< VariancePixelT >>	variance = Image<VariancePixelT>()
	)

A function to return a MaskedImage of the correct type (cf.

std::make_pair)

Parameters

image	image
mask	mask
variance	variance

Definition at line 1279 of file MaskedImage.h.

  {
    return new MaskedImage<ImagePixelT, MaskPixelT, VariancePixelT>(image, mask, variance);
}

makePhotoCalibFromCalibZeroPoint()

std::shared_ptr< PhotoCalib > lsst::afw::image::makePhotoCalibFromCalibZeroPoint	(	double	instFluxMag0,
		double	instFluxMag0Err
	)

Construct a PhotoCalib from the deprecated Calib-style instFluxMag0/instFluxMag0Err values.

This provides backwards compatibility with the obsoleted Calib object that PhotoCalib replaced. It should not be used outside of tests that compare with old persisted Calib objects.

Parameters

instFluxMag0	The instrumental flux at zero magnitude. If 0, the resulting PhotoCalib will have infinite calibrationMean and non-finite (inf or NaN) calibrationErr.
instFluxMag0Err	The instrumental flux at zero magnitude error. If 0, the resulting PhotoCalib will have 0 calibrationErr.

Returns

Pointer to the constructed PhotoCalib.

Definition at line 614 of file PhotoCalib.cc.

                                                                                                        {
    double calibration = utils::referenceFlux / instFluxMag0;
    double calibrationErr = utils::referenceFlux * instFluxMag0Err / std::pow(instFluxMag0, 2);
    return std::make_shared<PhotoCalib>(calibration, calibrationErr);
}

makePhotoCalibFromMetadata()

std::shared_ptr< PhotoCalib > lsst::afw::image::makePhotoCalibFromMetadata	(	daf::base::PropertySet &	metadata,
		bool	strip = false
	)

Construct a PhotoCalib from FITS FLUXMAG0/FLUXMAG0ERR keywords.

This provides backwards compatibility with the obsoleted Calib object that PhotoCalib replaced. It should not be used outside of reading old Exposures written before PhotoCalib existed.

Parameters

metadata	FITS header metadata containing FLUXMAG0 and FLUXMAG0ERR keys.
strip	Strip FLUXMAG0 and FLUXMAG0ERR from metadata?

Returns

Pointer to the constructed PhotoCalib, or nullptr if FLUXMAG0 is not in the metadata.

Definition at line 596 of file PhotoCalib.cc.

                                                                                               {
    auto key = "FLUXMAG0";
    if (metadata.exists(key)) {
        double instFluxMag0 = metadata.getAsDouble(key);
        if (strip) metadata.remove(key);
 
        double instFluxMag0Err = 0.0;
        key = "FLUXMAG0ERR";
        if (metadata.exists(key)) {
            instFluxMag0Err = metadata.getAsDouble(key);
            if (strip) metadata.remove(key);
        }
        return makePhotoCalibFromCalibZeroPoint(instFluxMag0, instFluxMag0Err);
    } else {
        return nullptr;
    }
}

operator*() [1/2]

template<typename PixelT >

std::shared_ptr< Image< PixelT > > lsst::afw::image::operator*	(	Image< PixelT > const &	img,
		ImageSlice< PixelT > const &	slc
	)

Overload operator*()

We'll define both 'image*slice' (this one) and 'slice*image' (next one down).

Parameters

img	The Image
slc	The ImageSlice

Definition at line 104 of file ImageSlice.cc.

                                                                                                {
    std::shared_ptr<Image<PixelT>> retImg(new Image<PixelT>(img, true));
    *retImg *= slc;
    return retImg;
}

operator*() [2/2]

template<typename PixelT >

std::shared_ptr< Image< PixelT > > lsst::afw::image::operator*	(	ImageSlice< PixelT > const &	slc,
		Image< PixelT > const &	img
	)

Overload operator*()

We'll define both 'image*slice' (this one) and 'slice*image' (next one down).

Parameters

slc	The Image
img	The ImageSlice

Definition at line 111 of file ImageSlice.cc.

                                                                                                {
    return operator*(img, slc);
}

operator*=() [1/2]

template<typename LhsPixelT , typename RhsPixelT >

Image< LhsPixelT > & lsst::afw::image::operator*=	(	Image< LhsPixelT > &	lhs,
		Image< RhsPixelT > const &	rhs
	)

Multiply lhs by Image rhs (i.e. pixel-by-pixel multiplication) where types are different.

Definition at line 683 of file Image.cc.

                                                                                 {
    for_each_pixel(lhs, rhs, timesEq<LhsPixelT, RhsPixelT>());
    return lhs;
}

operator*=() [2/2]

template<typename PixelT >

void lsst::afw::image::operator*=	(	Image< PixelT > &	img,
		ImageSlice< PixelT > const &	slc
	)

Overload operator*=()

Only 'image *= slice' is defined, as 'slice *= image' doesn't make sense.

Parameters

[in,out]	img	The Image
[in]	slc	The ImageSlice

Definition at line 116 of file ImageSlice.cc.

                                                                   {
    details::operate<details::Mult<PixelT>>(img, slc, slc.getImageSliceType());
}

operator+() [1/2]

template<typename PixelT >

std::shared_ptr< Image< PixelT > > lsst::afw::image::operator+	(	Image< PixelT > const &	img,
		ImageSlice< PixelT > const &	slc
	)

Overload operator+()

We require two of these, one for image+slice (this one) and one for slice+image (next one down)

Parameters

img	The Image
slc	The ImageSlice

Definition at line 69 of file ImageSlice.cc.

                                                                                                {
    std::shared_ptr<Image<PixelT>> retImg(new Image<PixelT>(img, true));
    *retImg += slc;
    return retImg;
}

operator+() [2/2]

template<typename PixelT >

std::shared_ptr< Image< PixelT > > lsst::afw::image::operator+	(	ImageSlice< PixelT > const &	slc,
		Image< PixelT > const &	img
	)

Overload operator+()

Parameters

slc	The ImageSlice
img	The Image

We require two of these, one for image+slice (previous one) and one for slice+image (this)

Definition at line 76 of file ImageSlice.cc.

                                                                                                {
    return operator+(img, slc);
}

operator+=() [1/2]

template<typename LhsPixelT , typename RhsPixelT >

Image< LhsPixelT > & lsst::afw::image::operator+=	(	Image< LhsPixelT > &	lhs,
		Image< RhsPixelT > const &	rhs
	)

Add lhs to Image rhs (i.e. pixel-by-pixel addition) where types are different.

Definition at line 671 of file Image.cc.

                                                                                 {
    for_each_pixel(lhs, rhs, plusEq<LhsPixelT, RhsPixelT>());
    return lhs;
}

operator+=() [2/2]

template<typename PixelT >

void lsst::afw::image::operator+=	(	Image< PixelT > &	img,
		ImageSlice< PixelT > const &	slc
	)

Overload operator+=()

We'll only allow 'image += slice'. It doesn't make sense to add an image to a slice.

Parameters

[in,out]	img	The Image
[in]	slc	The ImageSlice

Definition at line 81 of file ImageSlice.cc.

                                                                   {
    details::operate<details::Plus<PixelT>>(img, slc, slc.getImageSliceType());
}

operator-()

template<typename PixelT >

std::shared_ptr< Image< PixelT > > lsst::afw::image::operator-	(	Image< PixelT > const &	img,
		ImageSlice< PixelT > const &	slc
	)

Overload operator-()

We'll only allow 'image - slice', as 'slice - image' doesn't make sense.

Parameters

img	The Image
slc	The ImageSlice

Definition at line 89 of file ImageSlice.cc.

                                                                                                {
    std::shared_ptr<Image<PixelT>> retImg(new Image<PixelT>(img, true));
    *retImg -= slc;
    return retImg;
}

operator-=() [1/2]

template<typename LhsPixelT , typename RhsPixelT >

Image< LhsPixelT > & lsst::afw::image::operator-=	(	Image< LhsPixelT > &	lhs,
		Image< RhsPixelT > const &	rhs
	)

Subtract lhs from Image rhs (i.e. pixel-by-pixel subtraction) where types are different.

Definition at line 677 of file Image.cc.

                                                                                 {
    for_each_pixel(lhs, rhs, minusEq<LhsPixelT, RhsPixelT>());
    return lhs;
}

operator-=() [2/2]

template<typename PixelT >

void lsst::afw::image::operator-=	(	Image< PixelT > &	img,
		ImageSlice< PixelT > const &	slc
	)

Overload operator-=()

Only 'image -= slice' is defined. 'slice -= image' wouldn't make sense.

Parameters

[in,out]	img	The Image
[in]	slc	The ImageSlice

Definition at line 96 of file ImageSlice.cc.

                                                                   {
    details::operate<details::Minus<PixelT>>(img, slc, slc.getImageSliceType());
}

operator/()

template<typename PixelT >

std::shared_ptr< Image< PixelT > > lsst::afw::image::operator/	(	Image< PixelT > const &	img,
		ImageSlice< PixelT > const &	slc
	)

Overload operator/()

Only 'image / slice' is defined, as 'slice / image' doesn't make sense.

Parameters

img	The Image
slc	The ImageSlice

Definition at line 123 of file ImageSlice.cc.

                                                                                                {
    std::shared_ptr<Image<PixelT>> retImg(new Image<PixelT>(img, true));
    *retImg /= slc;
    return retImg;
}

operator/=() [1/2]

template<typename LhsPixelT , typename RhsPixelT >

Image< LhsPixelT > & lsst::afw::image::operator/=	(	Image< LhsPixelT > &	lhs,
		Image< RhsPixelT > const &	rhs
	)

Divide lhs by Image rhs (i.e. pixel-by-pixel division) where types are different.

Definition at line 689 of file Image.cc.

                                                                                 {
    for_each_pixel(lhs, rhs, divideEq<LhsPixelT, RhsPixelT>());
    return lhs;
}

operator/=() [2/2]

template<typename PixelT >

void lsst::afw::image::operator/=	(	Image< PixelT > &	img,
		ImageSlice< PixelT > const &	slc
	)

Overload operator/=()

Only 'image /= slice' is defined, as 'slice /= image' doesn't make sense.

Parameters

[in,out]	img	The Image
[in]	slc	The ImageSlice

Definition at line 130 of file ImageSlice.cc.

                                                                   {
    details::operate<details::Div<PixelT>>(img, slc, slc.getImageSliceType());
}

operator<<() [1/3]

std::ostream & lsst::afw::image::operator<<	(	std::ostream &	os,
		Measurement const &	measurement
	)

Definition at line 48 of file PhotoCalib.cc.

                                                                       {
    std::stringstream s;
    s << std::setprecision(std::numeric_limits<long double>::digits10 + 1);
    s << "value=" << measurement.value << ", error=" << measurement.error;
    return os << s.str();
}

operator<<() [2/3]

std::ostream& lsst::afw::image::operator<<	(	std::ostream &	os,
		PhotoCalib const &	photoCalib
	)

Definition at line 257 of file PhotoCalib.cc.

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

operator<<() [3/3]

std::ostream & lsst::afw::image::operator<<	(	std::ostream &	os,
		VisitInfo const &	visitInfo
	)

Definition at line 474 of file VisitInfo.cc.

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

positionToIndex() [1/3]

int lsst::afw::image::positionToIndex ( double &  residual, double  pos  )

inline

Convert image position to index (nearest integer and fractional parts)

The LSST indexing convention is:

• the index of the bottom left pixel is 0,0
• the position of the center of the bottom left pixel is PixelZeroPos, PixelZeroPos

Note: in python this is called positionToIndexAndResidual

Returns

nearest integer index

Parameters

residual	fractional part of index
pos	image position

Definition at line 85 of file ImageUtils.h.

  {
    double fullIndex = pos - PixelZeroPos;
    double roundedIndex = std::floor(fullIndex + 0.5);
    residual = fullIndex - roundedIndex;
    return static_cast<int>(roundedIndex);
}

positionToIndex() [2/3]

std::pair<int, double> lsst::afw::image::positionToIndex ( double const  pos, bool    )

inline

Convert image position to index (nearest integer and fractional parts)

Returns

std::pair(nearest integer index, fractional part)

Parameters

pos	image position

Definition at line 98 of file ImageUtils.h.

  {
    double residual;                                 // fractional part of index
    int const ind = positionToIndex(residual, pos);  // integral part
 
    return std::pair<int, double>(ind, residual);
}

positionToIndex() [3/3]

int lsst::afw::image::positionToIndex ( double  pos )

inline

Convert image position to nearest integer index.

The LSST indexing convention is:

• the index of the bottom left pixel is 0,0
• the position of the center of the bottom left pixel is PixelZeroPos, PixelZeroPos

Returns

nearest integer index

Parameters

pos	image position

Definition at line 69 of file ImageUtils.h.

  {
    return static_cast<int>(std::floor(pos + 0.5 - PixelZeroPos));
}

PYBIND11_MODULE() [1/4]

lsst::afw::image::PYBIND11_MODULE	(	imagePca	,
		mod
	)

Definition at line 63 of file imagePca.cc.

                               {
    declareImagePca<Image<int>>(mod, "I");
    declareImagePca<Image<float>>(mod, "F");
    declareImagePca<Image<double>>(mod, "D");
    declareImagePca<Image<std::uint16_t>>(mod, "U");
    declareImagePca<Image<std::uint64_t>>(mod, "L");
    declareImagePca<MaskedImage<int>>(mod, "MI");
    declareImagePca<MaskedImage<float>>(mod, "MF");
    declareImagePca<MaskedImage<double>>(mod, "MD");
    declareImagePca<MaskedImage<std::uint16_t>>(mod, "MU");
    declareImagePca<MaskedImage<std::uint64_t>>(mod, "ML");
 
    declareInnerProduct<Image<int>, Image<int>>(mod);
    declareInnerProduct<Image<float>, Image<float>>(mod);
    declareInnerProduct<Image<double>, Image<double>>(mod);
    declareInnerProduct<Image<std::uint16_t>, Image<std::uint16_t>>(mod);
    declareInnerProduct<Image<std::uint64_t>, Image<std::uint64_t>>(mod);
 
    declareInnerProduct<Image<float>, Image<double>>(mod);
    declareInnerProduct<Image<double>, Image<float>>(mod);
}

PYBIND11_MODULE() [2/4]

lsst::afw::image::PYBIND11_MODULE	(	maskedImage	,
		mod
	)

Definition at line 229 of file maskedImage.cc.

                                  {
    py::module::import("lsst.afw.image.image");
 
    auto clsMaskedImageF = declareMaskedImage<float>(mod, "F");
    auto clsMaskedImageD = declareMaskedImage<double>(mod, "D");
    auto clsMaskedImageI = declareMaskedImage<int>(mod, "I");
    auto clsMaskedImageU = declareMaskedImage<std::uint16_t>(mod, "U");
    auto clsMaskedImageL = declareMaskedImage<std::uint64_t>(mod, "L");
 
    // Declare constructors for casting all exposure types to to float and double
    // (the only two types of casts that Python supports)
    declareCastConstructor<int, float>(clsMaskedImageF);
    declareCastConstructor<int, double>(clsMaskedImageD);
    declareCastConstructor<float, double>(clsMaskedImageD);
    declareCastConstructor<double, float>(clsMaskedImageF);
    declareCastConstructor<std::uint16_t, float>(clsMaskedImageF);
    declareCastConstructor<std::uint16_t, double>(clsMaskedImageD);
    declareCastConstructor<std::uint64_t, float>(clsMaskedImageF);
    declareCastConstructor<std::uint64_t, double>(clsMaskedImageD);
 
    /* Module level */
    declareMakeMaskedImage<int>(mod);
    declareMakeMaskedImage<float>(mod);
    declareMakeMaskedImage<double>(mod);
    declareMakeMaskedImage<std::uint16_t>(mod);
    declareMakeMaskedImage<std::uint64_t>(mod);
 
    declareImagesOverlap<int, int>(mod);
    declareImagesOverlap<int, float>(mod);
    declareImagesOverlap<int, double>(mod);
    declareImagesOverlap<int, std::uint16_t>(mod);
    declareImagesOverlap<int, std::uint64_t>(mod);
 
    declareImagesOverlap<float, int>(mod);
    declareImagesOverlap<float, float>(mod);
    declareImagesOverlap<float, double>(mod);
    declareImagesOverlap<float, std::uint16_t>(mod);
    declareImagesOverlap<float, std::uint64_t>(mod);
 
    declareImagesOverlap<double, int>(mod);
    declareImagesOverlap<double, float>(mod);
    declareImagesOverlap<double, double>(mod);
    declareImagesOverlap<double, std::uint16_t>(mod);
    declareImagesOverlap<double, std::uint64_t>(mod);
 
    declareImagesOverlap<std::uint16_t, int>(mod);
    declareImagesOverlap<std::uint16_t, float>(mod);
    declareImagesOverlap<std::uint16_t, double>(mod);
    declareImagesOverlap<std::uint16_t, std::uint16_t>(mod);
    declareImagesOverlap<std::uint16_t, std::uint64_t>(mod);
 
    declareImagesOverlap<std::uint64_t, int>(mod);
    declareImagesOverlap<std::uint64_t, float>(mod);
    declareImagesOverlap<std::uint64_t, double>(mod);
    declareImagesOverlap<std::uint64_t, std::uint16_t>(mod);
    declareImagesOverlap<std::uint64_t, std::uint64_t>(mod);
}

PYBIND11_MODULE() [3/4]

lsst::afw::image::PYBIND11_MODULE	(	readMetadata	,
		mod
	)

Definition at line 34 of file readMetadata.cc.

                                   {  // wraps code in Utils.h, but there's an unrelated utils.py
    /* Module level */
    mod.def("readMetadata", readMetadata, "fileName"_a, "hdu"_a = fits::DEFAULT_HDU, "strip"_a = false);
}

PYBIND11_MODULE() [4/4]

lsst::afw::image::PYBIND11_MODULE	(	visitInfo	,
		mod
	)

Definition at line 55 of file visitInfo.cc.

                                {
    py::module::import("lsst.daf.base");
    py::module::import("lsst.geom");
    py::module::import("lsst.afw.coord.observatory");
    py::module::import("lsst.afw.coord.weather");
    py::module::import("lsst.afw.typehandling");
 
    /* Module level */
    py::class_<VisitInfo, std::shared_ptr<VisitInfo>, typehandling::Storable> cls(mod, "VisitInfo");
 
    /* Member types and enums */
    py::enum_<RotType>(mod, "RotType")
            .value("UNKNOWN", RotType::UNKNOWN)
            .value("SKY", RotType::SKY)
            .value("HORIZON", RotType::HORIZON)
            .value("MOUNT", RotType::MOUNT)
            .export_values();
 
    /* Constructors */
    cls.def(py::init<table::RecordId, double, double, daf::base::DateTime const &, double,
                     lsst::geom::Angle const &, lsst::geom::SpherePoint const &, lsst::geom::SpherePoint const &, double,
                     lsst::geom::Angle const &, RotType const &, coord::Observatory const &,
                     coord::Weather const &>(),
            "exposureId"_a = 0, "exposureTime"_a = nan, "darkTime"_a = nan, "date"_a = daf::base::DateTime(),
            "ut1"_a = nan, "era"_a = nanAngle, "boresightRaDec"_a = lsst::geom::SpherePoint(nanAngle, nanAngle),
            "boresightAzAlt"_a = lsst::geom::SpherePoint(nanAngle, nanAngle), "boresightAirmass"_a = nan,
            "boresightRotAngle"_a = nanAngle, "rotType"_a = RotType::UNKNOWN,
            "observatory"_a = coord::Observatory(nanAngle, nanAngle, nan),
            "weather"_a = coord::Weather(nan, nan, nan));
    cls.def(py::init<daf::base::PropertySet const &>(), "metadata"_a);
    cls.def(py::init<VisitInfo const &>(), "visitInfo"_a);
 
    table::io::python::addPersistableMethods<VisitInfo>(cls);
 
    /* Operators */
    cls.def("__eq__", [](VisitInfo const &self, VisitInfo const &other) { return self == other; },
            py::is_operator());
    cls.def("__ne__", [](VisitInfo const &self, VisitInfo const &other) { return self != other; },
            py::is_operator());
 
    /* Members */
    cls.def("getExposureId", &VisitInfo::getExposureId);
    cls.def("getExposureTime", &VisitInfo::getExposureTime);
    cls.def("getDarkTime", &VisitInfo::getDarkTime);
    cls.def("getDate", &VisitInfo::getDate);
    cls.def("getUt1", &VisitInfo::getUt1);
    cls.def("getEra", &VisitInfo::getEra);
    cls.def("getBoresightRaDec", &VisitInfo::getBoresightRaDec);
    cls.def("getBoresightAzAlt", &VisitInfo::getBoresightAzAlt);
    cls.def("getBoresightAirmass", &VisitInfo::getBoresightAirmass);
    cls.def("getBoresightParAngle", &VisitInfo::getBoresightParAngle);
    cls.def("getBoresightRotAngle", &VisitInfo::getBoresightRotAngle);
    cls.def("getRotType", &VisitInfo::getRotType);
    cls.def("getObservatory", &VisitInfo::getObservatory);
    cls.def("getWeather", &VisitInfo::getWeather);
    cls.def("isPersistable", &VisitInfo::isPersistable);
    cls.def("getLocalEra", &VisitInfo::getLocalEra);
    cls.def("getBoresightHourAngle", &VisitInfo::getBoresightHourAngle);
 
    utils::python::addOutputOp(cls, "__str__");
 
    /* Free Functions */
    mod.def("setVisitInfoMetadata", &detail::setVisitInfoMetadata, "metadata"_a, "visitInfo"_a);
    mod.def("stripVisitInfoKeywords", &detail::stripVisitInfoKeywords, "metadata"_a);
}

readMetadata()

std::shared_ptr<daf::base::PropertyList> lsst::afw::image::readMetadata ( std::string const &  fileName, int  hdu = fits::DEFAULT_HDU, bool  strip = false  )

inline

Return the metadata (header entries) from a FITS file.

Deprecated:

Use lsst::afw::fits::readMetadata instead.

Parameters

[in]	fileName	File to read.
[in]	hdu	HDU to read, 0-indexed. The special value of afw::fits::DEFAULT_HDU will read the first non-empty HDU.
[in]	strip	If true, ignore special header keys usually managed by cfitsio (e.g. NAXIS).

Definition at line 65 of file Utils.h.

                                                                                               {
    return afw::fits::readMetadata(fileName, hdu, strip);
}

swap() [1/4]

template<typename PixelT >

void lsst::afw::image::swap	(	DecoratedImage< PixelT > &	a,
		DecoratedImage< PixelT > &	b
	)

Definition at line 90 of file DecoratedImage.cc.

                                                                {
    a.swap(b);
}

swap() [2/4]

template<typename PixelT >

void lsst::afw::image::swap	(	Image< PixelT > &	a,
		Image< PixelT > &	b
	)

Definition at line 456 of file Image.cc.

                                              {
    a.swap(b);
}

swap() [3/4]

template<typename PixelT >

void lsst::afw::image::swap	(	ImageBase< PixelT > &	a,
		ImageBase< PixelT > &	b
	)

Definition at line 255 of file Image.cc.

                                                      {
    a.swap(b);
}

swap() [4/4]

template<typename PixelT >

void lsst::afw::image::swap	(	Mask< PixelT > &	a,
		Mask< PixelT > &	b
	)

Definition at line 141 of file Mask.cc.

                                            {
    a.swap(b);
}

Variable Documentation

PixelZeroPos

const double lsst::afw::image::PixelZeroPos = 0.0

position of center of pixel 0

FITS uses 1.0, SDSS uses 0.5, LSST uses 0.0 (http://dev.lsstcorp.org/trac/wiki/BottomLeftPixelProposalII%3A)

Definition at line 44 of file ImageUtils.h.