lsst::afw::cameraGeom Namespace Reference

Namespaces
namespace	_amplifier
namespace	_assembleImage
namespace	_camera
namespace	_cameraFactory
namespace	_cameraGeomEnumDicts
namespace	_detector
namespace	_detectorCollection
namespace	_makePixelToTanPixel
namespace	_rotateBBoxBy90
namespace	_transformConfig
namespace	cameraConfig
namespace	pupil
namespace	testUtils
namespace	utils

Classes
class	Amplifier
	Geometry and electronic information about raw amplifier images. More...
class	Camera
	An immutable representation of a camera. More...
class	CameraSys
	Camera coordinate system; used as a key in in TransformMap. More...
class	CameraSysPrefix
	Camera coordinate system prefix. More...
class	Detector
	A representation of a detector in a mosaic camera. More...
class	DetectorBase
	An abstract base class that provides common accessors for Detector and Detector::Builder. More...
class	DetectorCollection
	An immutable collection of Detectors that can be accessed by name or ID. More...
class	DetectorCollectionBase
	An abstract base class for collections of Detectors and specific subclasses thereof. More...
class	Orientation
	Describe a detector's orientation in the focal plane. More...
class	TransformMap
	A registry of 2-dimensional coordinate transforms for a specific camera. More...

Typedefs
using	PyAmplifier = py::class_<Amplifier, std::shared_ptr<Amplifier>>
using	PyAmplifierBuilder = py::class_<Amplifier::Builder, Amplifier, std::shared_ptr<Amplifier::Builder>>
using	PyCamera = py::class_<Camera, DetectorCollection, std::shared_ptr<Camera>>
using	PyCameraBuilder

Enumerations
enum class	ReadoutCorner { LL , LR , UR , UL }
	Readout corner, in the frame of reference of the assembled image. More...
enum class	AssemblyState { RAW , SCIENCE }
	Assembly state of the amplifier, used to identify bounding boxes and component existence. More...
enum class	DetectorType { SCIENCE , FOCUS , GUIDER , WAVEFRONT }
	Type of imaging detector. More...

Functions
void	swap (CameraSys &a, CameraSys &b)
std::ostream &	operator<< (std::ostream &os, CameraSysPrefix const &detSysPrefix)
std::ostream &	operator<< (std::ostream &os, CameraSys const &cameraSys)
std::ostream &	operator<< (std::ostream &os, TransformMap::Connection const &connection)
void	wrapAmplifier (lsst::utils::python::WrapperCollection &wrappers)
void	wrapCamera (lsst::utils::python::WrapperCollection &wrappers)
void	wrapCameraSys (lsst::utils::python::WrapperCollection &)
void	wrapDetector (lsst::utils::python::WrapperCollection &)
void	wrapDetectorCollection (lsst::utils::python::WrapperCollection &)
void	wrapOrientation (lsst::utils::python::WrapperCollection &)
void	wrapTransformMap (lsst::utils::python::WrapperCollection &)
	PYBIND11_MODULE (_cameraGeom, mod)

Variables
CameraSys const	FOCAL_PLANE = CameraSys("FocalPlane")
	Focal plane coordinates: Position on a 2-d planar approximation to the focal plane (x,y mm).
CameraSys const	FIELD_ANGLE = CameraSys("FieldAngle")
	Field angle coordinates: Angle of a principal ray relative to the optical axis (x,y radians).
CameraSysPrefix const	PIXELS = CameraSysPrefix("Pixels")
	Pixel coordinates: Nominal position on the entry surface of a given detector (x, y unbinned pixels).
CameraSysPrefix const	TAN_PIXELS = CameraSysPrefix("TanPixels")
	Tangent-plane pixels on the detector (x, y unbinned pixels)
CameraSysPrefix const	ACTUAL_PIXELS = CameraSysPrefix("ActualPixels")
	The actual pixels where the photon lands and electrons are generated (x,y unbinned) This takes into account manufacturing defects, "tree ring" distortions and other such effects.
str	NullLinearityType = "None"

Detailed Description

Application Framework classes to handle a mosaic camera's geometry

Typedef Documentation

PyAmplifier

using lsst::afw::cameraGeom::PyAmplifier = py::class_<Amplifier, std::shared_ptr<Amplifier>>

Definition at line 40 of file _amplifier.cc.

PyAmplifierBuilder

using lsst::afw::cameraGeom::PyAmplifierBuilder = py::class_<Amplifier::Builder, Amplifier, std::shared_ptr<Amplifier::Builder>>

Definition at line 41 of file _amplifier.cc.

PyCamera

using lsst::afw::cameraGeom::PyCamera = py::class_<Camera, DetectorCollection, std::shared_ptr<Camera>>

Definition at line 40 of file _camera.cc.

PyCameraBuilder

using lsst::afw::cameraGeom::PyCameraBuilder

Initial value:

 py::class_<Camera::Builder, DetectorCollectionBase<Detector::InCameraBuilder>,
                                   std::shared_ptr<Camera::Builder>>

Definition at line 41 of file _camera.cc.

Enumeration Type Documentation

AssemblyState

enum class lsst::afw::cameraGeom::AssemblyState

strong

Assembly state of the amplifier, used to identify bounding boxes and component existence.

Enumerator
RAW
SCIENCE

Definition at line 48 of file Amplifier.h.

                         {
    RAW,
    SCIENCE,
};

DetectorType

enum class lsst::afw::cameraGeom::DetectorType

strong

Type of imaging detector.

Enumerator
SCIENCE
FOCUS
GUIDER
WAVEFRONT

Definition at line 44 of file Detector.h.

                        {
    SCIENCE,
    FOCUS,
    GUIDER,
    WAVEFRONT,
};

ReadoutCorner

enum class lsst::afw::cameraGeom::ReadoutCorner

strong

Readout corner, in the frame of reference of the assembled image.

Enumerator
LL
LR
UR
UL

Definition at line 38 of file Amplifier.h.

                         {
    LL,
    LR,
    UR,
    UL,
};

Function Documentation

operator<<() [1/3]

std::ostream & lsst::afw::cameraGeom::operator<<	(	std::ostream &	os,
		CameraSys const &	cameraSys )

Definition at line 52 of file CameraSys.cc.

                                                                   {
    os << "CameraSys(" << cameraSys.getSysName();
    if (cameraSys.hasDetectorName()) {
        os << ", " << cameraSys.getDetectorName();
    }
    os << ")";
    return os;
}

operator<<() [2/3]

std::ostream & lsst::afw::cameraGeom::operator<<	(	std::ostream &	os,
		CameraSysPrefix const &	detSysPrefix )

Definition at line 47 of file CameraSys.cc.

                                                                            {
    os << "CameraSysPrefix(" << camSysPrefix.getSysName() << ")";
    return os;
}

operator<<() [3/3]

std::ostream & lsst::afw::cameraGeom::operator<<	(	std::ostream &	os,
		TransformMap::Connection const &	connection )

Definition at line 169 of file TransformMap.cc.

                                                                                    {
    return os << connection.fromSys << "->" << connection.toSys;
}

PYBIND11_MODULE()

lsst::afw::cameraGeom::PYBIND11_MODULE	(	_cameraGeom	,
		mod	)

Definition at line 38 of file _cameraGeom.cc.

                                  {
    lsst::utils::python::WrapperCollection wrappers(mod, "lsst.afw.cameraGeom");
    wrapAmplifier(wrappers);
    wrapDetectorCollection(wrappers);
    wrapDetector(wrappers);
    wrapCamera(wrappers);
    wrapCameraSys(wrappers);
    wrapOrientation(wrappers);
    wrapTransformMap(wrappers);
    wrappers.finish();
}

swap()

void lsst::afw::cameraGeom::swap ( CameraSys & a, CameraSys & b )

inline

Definition at line 157 of file CameraSys.h.

                                               {
    a.swap(b);
}

wrapAmplifier()

void lsst::afw::cameraGeom::wrapAmplifier

(

lsst::utils::python::WrapperCollection &

wrappers

)

Definition at line 43 of file _amplifier.cc.

                                                               {
    wrappers.addInheritanceDependency("lsst.afw.table");
    wrappers.wrapType(py::enum_<ReadoutCorner>(wrappers.module, "ReadoutCorner"), [](auto &mod, auto &enm) {
        enm.value("LL", ReadoutCorner::LL);
        enm.value("LR", ReadoutCorner::LR);
        enm.value("UR", ReadoutCorner::UR);
        enm.value("UL", ReadoutCorner::UL);
    });
    wrappers.wrapType(py::enum_<AssemblyState>(wrappers.module, "AssemblyState"), [](auto &mod, auto &enm) {
        enm.value("RAW", AssemblyState::RAW);
        enm.value("SCIENCE", AssemblyState::SCIENCE);
    });
    auto amplifier = wrappers.wrapType(PyAmplifier(wrappers.module, "Amplifier"), [](auto &mod, auto &cls) {
        cls.def_static("getRecordSchema", &Amplifier::getRecordSchema);
        cls.def("toRecord", &Amplifier::toRecord);
        cls.def("rebuild", &Amplifier::rebuild);
        cls.def("getName", &Amplifier::getName);
        cls.def("getBBox", &Amplifier::getBBox);
        cls.def("getGain", &Amplifier::getGain);
        cls.def("getReadNoise", &Amplifier::getReadNoise);
        cls.def("getSaturation", &Amplifier::getSaturation);
        cls.def("getSuspectLevel", &Amplifier::getSuspectLevel);
        cls.def("getReadoutCorner", &Amplifier::getReadoutCorner);
        cls.def("getLinearityCoeffs", &Amplifier::getLinearityCoeffs);
        cls.def("getLinearityType", &Amplifier::getLinearityType);
        cls.def("getLinearityThreshold", &Amplifier::getLinearityThreshold);
        cls.def("getLinearityMaximum", &Amplifier::getLinearityMaximum);
        cls.def("getLinearityUnits", &Amplifier::getLinearityUnits);
        cls.def("getRawBBox", &Amplifier::getRawBBox);
        cls.def("getRawDataBBox", &Amplifier::getRawDataBBox);
        cls.def("getRawFlipX", &Amplifier::getRawFlipX);
        cls.def("getRawFlipY", &Amplifier::getRawFlipY);
        cls.def("getRawXYOffset", &Amplifier::getRawXYOffset);
        cls.def("getRawHorizontalOverscanBBox", &Amplifier::getRawHorizontalOverscanBBox);
        cls.def("getRawVerticalOverscanBBox", &Amplifier::getRawVerticalOverscanBBox);
        cls.def("getRawPrescanBBox", &Amplifier::getRawPrescanBBox);
        cls.def("getRawSerialOverscanBBox", &Amplifier::getRawSerialOverscanBBox);
        cls.def("getRawParallelOverscanBBox", &Amplifier::getRawParallelOverscanBBox);
        cls.def("getRawSerialPrescanBBox", &Amplifier::getRawSerialPrescanBBox);
        cls.def("getRawHorizontalPrescanBBox", &Amplifier::getRawHorizontalPrescanBBox);
    });
    wrappers.wrapType(PyAmplifierBuilder(amplifier, "Builder"), [](auto &mod, auto &cls) {
        cls.def_static("fromRecord", &Amplifier::Builder::fromRecord);
        cls.def(py::init());
        cls.def("finish", &Amplifier::Builder::finish);
        cls.def("assign", [](Amplifier::Builder &self, Amplifier const &other) { self = other; });
        cls.def("setName", &Amplifier::Builder::setName, "name"_a);
        cls.def("setBBox", &Amplifier::Builder::setBBox, "bbox"_a);
        cls.def("setGain", &Amplifier::Builder::setGain, "gain"_a);
        cls.def("setReadNoise", &Amplifier::Builder::setReadNoise, "readNoise"_a);
        cls.def("setSaturation", &Amplifier::Builder::setSaturation, "saturation"_a);
        cls.def("setSuspectLevel", &Amplifier::Builder::setSuspectLevel, "suspectLevel"_a);
        cls.def("setReadoutCorner", &Amplifier::Builder::setReadoutCorner, "corner"_a);
        cls.def("setLinearityCoeffs", &Amplifier::Builder::setLinearityCoeffs, "coeffs"_a);
        // Backwards compatibility: accept std::vector (list in Python) in
        // addition to ndarray::Array (np.ndarray)
        cls.def("setLinearityCoeffs", [](Amplifier::Builder &self, std::vector<double> const &coeffs) {
            ndarray::Array<double, 1, 1> array = ndarray::allocate(coeffs.size());
            std::copy(coeffs.begin(), coeffs.end(), array.begin());
            self.setLinearityCoeffs(array);
        });
        cls.def("setLinearityType", &Amplifier::Builder::setLinearityType, "type"_a);
        cls.def("setLinearityThreshold", &Amplifier::Builder::setLinearityThreshold, "threshold"_a);
        cls.def("setLinearityMaximum", &Amplifier::Builder::setLinearityMaximum, "maximum"_a);
        cls.def("setLinearityUnits", &Amplifier::Builder::setLinearityUnits, "units"_a);
        cls.def("setRawBBox", &Amplifier::Builder::setRawBBox, "bbox"_a);
        cls.def("setRawDataBBox", &Amplifier::Builder::setRawDataBBox, "bbox"_a);
        cls.def("setRawFlipX", &Amplifier::Builder::setRawFlipX, "rawFlipX"_a);
        cls.def("setRawFlipY", &Amplifier::Builder::setRawFlipY, "rawFlipY"_a);
        cls.def("setRawXYOffset", &Amplifier::Builder::setRawXYOffset, "offset"_a);
        cls.def("setRawHorizontalOverscanBBox", &Amplifier::Builder::setRawHorizontalOverscanBBox, "bbox"_a);
        cls.def("setRawVerticalOverscanBBox", &Amplifier::Builder::setRawVerticalOverscanBBox, "bbox"_a);
        cls.def("setRawPrescanBBox", &Amplifier::Builder::setRawPrescanBBox, "bbox"_a);
        cls.def("setRawSerialOverscanBBox", &Amplifier::Builder::setRawSerialOverscanBBox, "bbox"_a);
        cls.def("setRawParallelOverscanBBox", &Amplifier::Builder::setRawParallelOverscanBBox, "bbox"_a);
        cls.def("setRawSerialPrescanBBox", &Amplifier::Builder::setRawSerialPrescanBBox, "bbox"_a);
        cls.def("setRawHorizontalPrescanBBox", &Amplifier::Builder::setRawHorizontalPrescanBBox, "bbox"_a);
    });
}

wrapCamera()

void lsst::afw::cameraGeom::wrapCamera

(

lsst::utils::python::WrapperCollection &

wrappers

)

Definition at line 48 of file _camera.cc.

                                                            {
    wrappers.addInheritanceDependency("lsst.afw.table.io");
    wrappers.addSignatureDependency("lsst.afw.cameraGeom");
    auto camera = wrappers.wrapType(PyCamera(wrappers.module, "Camera"), [](auto &mod, auto &cls) {
        cls.def("rebuild", &Camera::rebuild);
        cls.def("getName", &Camera::getName);
        cls.def("getPupilFactoryName", &Camera::getPupilFactoryName);
        cls.def("findDetectors", &Camera::findDetectors, "point"_a, "cameraSys"_a);
        cls.def("findDetectorsList", &Camera::findDetectorsList, "pointList"_a, "cameraSys"_a);
        // transform methods are wrapped with lambdas that translate exceptions for backwards compatibility
        cls.def(
                "getTransform",
                [](Camera const &self, CameraSys const &fromSys, CameraSys const &toSys) {
                    try {
                        return self.getTransform(fromSys, toSys);
                    } catch (pex::exceptions::NotFoundError &err) {
                        PyErr_SetString(PyExc_KeyError, err.what());
                        throw py::error_already_set();
                    }
                },
                "fromSys"_a, "toSys"_a);
        cls.def("getTransformMap", &Camera::getTransformMap);
        cls.def(
                "transform",
                [](Camera const &self, lsst::geom::Point2D const &point, CameraSys const &fromSys,
                   CameraSys const &toSys) {
                    try {
                        return self.transform(point, fromSys, toSys);
                    } catch (pex::exceptions::NotFoundError &err) {
                        PyErr_SetString(PyExc_KeyError, err.what());
                        throw py::error_already_set();
                    }
                },
                "point"_a, "fromSys"_a, "toSys"_a);
        cls.def(
                "transform",
                [](Camera const &self, std::vector<lsst::geom::Point2D> const &points,
                   CameraSys const &fromSys, CameraSys const &toSys) {
                    try {
                        return self.transform(points, fromSys, toSys);
                    } catch (pex::exceptions::NotFoundError &err) {
                        PyErr_SetString(PyExc_KeyError, err.what());
                        throw py::error_already_set();
                    }
                },
                "points"_a, "fromSys"_a, "toSys"_a);
        table::io::python::addPersistableMethods(cls);
    });
    wrappers.wrapType(PyCameraBuilder(camera, "Builder"), [](auto &mod, auto &cls) {
        cls.def(py::init<std::string const &>(), "name"_a);
        cls.def(py::init<Camera const &>(), "camera"_a);
        cls.def("finish", &Camera::Builder::finish);
        cls.def("getName", &Camera::Builder::getName);
        cls.def("setName", &Camera::Builder::setName);
        cls.def("getPupilFactoryName", &Camera::Builder::getPupilFactoryName);
        cls.def("setPupilFactoryName", &Camera::Builder::setPupilFactoryName);
        cls.def("setPupilFactoryClass", [](Camera::Builder &self, py::object pupilFactoryClass) {
            std::string pupilFactoryName = "lsst.afw.cameraGeom.pupil.PupilFactory";
            if (!pupilFactoryClass.is(py::none())) {
                pupilFactoryName = py::str("{}.{}").format(pupilFactoryClass.attr("__module__"),
                                                           pupilFactoryClass.attr("__name__"));
            }
            self.setPupilFactoryName(pupilFactoryName);
        });
        cls.def("setTransformFromFocalPlaneTo", &Camera::Builder::setTransformFromFocalPlaneTo, "toSys"_a,
                "transform"_a);
        cls.def("discardTransformFromFocalPlaneTo", &Camera::Builder::discardTransformFromFocalPlaneTo);
        cls.def("add", &Camera::Builder::add);
        cls.def("__delitem__", py::overload_cast<int>(&Camera::Builder::remove));
        cls.def("__delitem__", py::overload_cast<std::string const &>(&Camera::Builder::remove));
    });
}

wrapCameraSys()

void lsst::afw::cameraGeom::wrapCameraSys

(

lsst::utils::python::WrapperCollection &

wrappers

)

Definition at line 65 of file _cameraSys.cc.

                                                               {
    /* Module level */
    wrappers.wrapType(py::class_<CameraSysPrefix>(wrappers.module, "CameraSysPrefix"),
                      [](auto &mod, auto &cls) {
                          declareCommonSysMethods<CameraSysPrefix>(cls);
                          cls.def(py::init<std::string const &>(), "sysName"_a);
                      });
    wrappers.wrapType(py::class_<CameraSys>(wrappers.module, "CameraSys"), [](auto &mod, auto &cls) {
        declareCommonSysMethods<CameraSys>(cls);
        /* Constructors */
        cls.def(py::init<std::string const &>(), "sysName"_a);
        cls.def(py::init<std::string const &, std::string const &>(), "sysName"_a, "detectorName"_a = "");
        cls.def(py::init<CameraSysPrefix const &, std::string const &>(), "sysPrefix"_a,
                "detectorName"_a = "");
        /* Members */
        cls.def("getDetectorName", &CameraSys::getDetectorName);
        cls.def("hasDetectorName", &CameraSys::hasDetectorName);
    });
 
    // The following must come after the associated pybind11 class is declared
    // (e.g. FOCAL_PLANE is a CameraSys, so clsCameraSys must have been declared
    wrappers.wrap([](auto &mod) {
        mod.attr("FOCAL_PLANE") = py::cast(FOCAL_PLANE);
        mod.attr("FIELD_ANGLE") = py::cast(FIELD_ANGLE);
        mod.attr("PIXELS") = py::cast(PIXELS);
        mod.attr("TAN_PIXELS") = py::cast(TAN_PIXELS);
        mod.attr("ACTUAL_PIXELS") = py::cast(ACTUAL_PIXELS);
    });
}

wrapDetector()

void lsst::afw::cameraGeom::wrapDetector

(

lsst::utils::python::WrapperCollection &

wrappers

)

Definition at line 195 of file _detector.cc.

                                                              {
    wrappers.addInheritanceDependency("lsst.afw.typehandling");
    wrappers.wrapType(py::enum_<DetectorType>(wrappers.module, "DetectorType"), [](auto &mod, auto &enm) {
        enm.value("SCIENCE", DetectorType::SCIENCE);
        enm.value("FOCUS", DetectorType::FOCUS);
        enm.value("GUIDER", DetectorType::GUIDER);
        enm.value("WAVEFRONT", DetectorType::WAVEFRONT);
    });
    declareDetectorBase(wrappers);
    declareDetector(wrappers);
}

wrapDetectorCollection()

void lsst::afw::cameraGeom::wrapDetectorCollection

(

lsst::utils::python::WrapperCollection &

wrappers

)

Definition at line 66 of file _detectorCollection.cc.

                                                                        {
    wrappers.addInheritanceDependency("lsst.afw.table.io");
    wrappers.wrapType(
            PyDetectorCollectionBase<Detector const>(wrappers.module, "DetectorCollectionDetectorBase"),
            [](auto &mod, auto &cls) { declareDetectorCollectionBase(cls); });
    wrappers.wrapType(PyDetectorCollection(wrappers.module, "DetectorCollection"), [](auto &mod, auto &cls) {
        ;
        cls.def(py::init<DetectorCollection::List>());
        cls.def("getFpBBox", &DetectorCollection::getFpBBox);
        table::io::python::addPersistableMethods(cls);
    });
 
    wrappers.wrapType(PyDetectorCollectionBase<Detector::InCameraBuilder>(wrappers.module,
                                                                          "DetectorCollectionBuilderBase"),
                      [](auto &mod, auto &cls) { declareDetectorCollectionBase(cls); });
}

wrapOrientation()

void lsst::afw::cameraGeom::wrapOrientation

(

lsst::utils::python::WrapperCollection &

wrappers

)

Definition at line 36 of file _orientation.cc.

                                                                 {
    wrappers.addSignatureDependency("lsst.geom");
    wrappers.wrapType(py::class_<Orientation>(wrappers.module, "Orientation"), [](auto &mod, auto &cls) {
        /* Constructors */
        cls.def(py::init<lsst::geom::Point3D, lsst::geom::Point2D, lsst::geom::Angle, lsst::geom::Angle,
                         lsst::geom::Angle>(),
                "fpPosition"_a = lsst::geom::Point3D(0, 0, 0), "refPoint"_a = lsst::geom::Point2D(-0.5, -0.5),
                "yaw"_a = lsst::geom::Angle(0), "pitch"_a = lsst::geom::Angle(0),
                "roll"_a = lsst::geom::Angle(0));
 
        cls.def(py::init<lsst::geom::Point2D, lsst::geom::Point2D, lsst::geom::Angle, lsst::geom::Angle,
                         lsst::geom::Angle>(),
                "fpPosition"_a, "refPoint"_a = lsst::geom::Point2D(-0.5, -0.5),
                "yaw"_a = lsst::geom::Angle(0), "pitch"_a = lsst::geom::Angle(0),
                "roll"_a = lsst::geom::Angle(0));
 
        /* Operators */
 
        /* Members */
        cls.def("getFpPosition", &Orientation::getFpPosition);
        cls.def("getFpPosition3", &Orientation::getFpPosition3);
        cls.def("getReferencePoint", &Orientation::getReferencePoint);
        cls.def("getHeight", &Orientation::getHeight);
        cls.def("getYaw", &Orientation::getYaw);
        cls.def("getPitch", &Orientation::getPitch);
        cls.def("getRoll", &Orientation::getRoll);
        cls.def("getNQuarter", &Orientation::getNQuarter);
        cls.def("makePixelFpTransform", &Orientation::makePixelFpTransform, "pixelSizeMm"_a);
        cls.def("makeFpPixelTransform", &Orientation::makeFpPixelTransform, "pixelSizeMm"_a);
    });
}

wrapTransformMap()

void lsst::afw::cameraGeom::wrapTransformMap

(

lsst::utils::python::WrapperCollection &

wrappers

)

Definition at line 94 of file _transformMap.cc.

{ declareTransformMap(wrappers); }

Variable Documentation

ACTUAL_PIXELS

CameraSysPrefix const lsst::afw::cameraGeom::ACTUAL_PIXELS = CameraSysPrefix("ActualPixels")

The actual pixels where the photon lands and electrons are generated (x,y unbinned) This takes into account manufacturing defects, "tree ring" distortions and other such effects.

This is a detector prefix; call Detector.makeCameraSys(ACTUAL_PIXELS) to make a full CameraSys.

Definition at line 38 of file CameraSys.cc.

FIELD_ANGLE

CameraSys const lsst::afw::cameraGeom::FIELD_ANGLE = CameraSys("FieldAngle")

Field angle coordinates: Angle of a principal ray relative to the optical axis (x,y radians).

The orientation of the x,y axes is the same as FOCAL_PLANE.

Definition at line 32 of file CameraSys.cc.

FOCAL_PLANE

CameraSys const lsst::afw::cameraGeom::FOCAL_PLANE = CameraSys("FocalPlane")

Focal plane coordinates: Position on a 2-d planar approximation to the focal plane (x,y mm).

The origin and orientation may be defined by the camera team, but we strongly recommend that the origin be on the optical axis and (if using CCD detectors) that the X axis be aligned along CCD rows.

Note

Location and orientation of detectors are defined in a 3-d version of FOCAL_PLANE coordinates (the z axis is also relevant). Rectilinear x, y (and z when talking about the location of a detector) on the camera focal plane (mm). For z=0 choose a convenient point near the focus at x, y = 0.

Definition at line 30 of file CameraSys.cc.

NullLinearityType

str lsst.afw.cameraGeom.NullLinearityType = "None"

Definition at line 38 of file __init__.py.

PIXELS

CameraSysPrefix const lsst::afw::cameraGeom::PIXELS = CameraSysPrefix("Pixels")

Pixel coordinates: Nominal position on the entry surface of a given detector (x, y unbinned pixels).

For CCD detectors the x axis must be along rows (the direction of the serial register). This is required for our interpolation algorithm to interpolate across bad columns.

This ignores manufacturing imperfections, "tree ring" distortions and all other such effects. It is a uniform grid of rectangular (usually square) pixels.

Warning

This is a detector prefix; call Detector.makeCameraSys(PIXELS) to make a full CameraSys.

Definition at line 34 of file CameraSys.cc.

TAN_PIXELS

CameraSysPrefix const lsst::afw::cameraGeom::TAN_PIXELS = CameraSysPrefix("TanPixels")

Tangent-plane pixels on the detector (x, y unbinned pixels)

Converting from PIXELS to TAN_PIXELS has the effect of removing optical distortion (and the distortion due to rectangular pixels) with the point at the center of the detector being unaffected by the transformation.

In detail, PIXELS->TAN_PIXELS is PIXELS->FIELD_ANGLE plus an affine transformation, such that:

• The x,y axes are parallel to the detector axes
• The dimensions are nominal pixels at the center of the focal plane (where nominal pixels size is mean of x, y pixel size).
• The point at the center of the detector has the same value in PIXELS and TAN_PIXELS

This is a detector prefix; call Detector.makeCameraSys(TAN_PIXELS) to make a full CameraSys.

Definition at line 36 of file CameraSys.cc.