lsst.meas.extensions.trailedSources  master-gcc5351303a+d444c565fc
Public Types | Public Member Functions | List of all members
lsst::meas::extensions::trailedSources::VeresModel Class Referencefinal

Implementation of an axisymmetric 2D Gaussian convolved with a line – a model for a fast-moving, trailed-source (Veres et al. More...

#include <VeresModel.h>

Public Types

using ImageF = afw::image::Image< float >
 
using ExposureF = afw::image::Exposure< float >
 

Public Member Functions

 VeresModel (ExposureF const &data)
 Constructor for VeresModel. More...
 
 VeresModel (VeresModel const &)=default
 
 VeresModel (VeresModel &&)=default
 
VeresModeloperator= (VeresModel const &)=default
 
VeresModeloperator= (VeresModel &&)=default
 
 ~VeresModel ()=default
 
double operator() (std::vector< double > const &params) const
 Compute chi-squared of the model given the data. More...
 
std::vector< double > gradient (std::vector< double > const &params) const
 Compute the gradient of chi-squared of the model given the data. More...
 
double getSigma () const noexcept
 Return the PSF sigma. More...
 

Detailed Description

Implementation of an axisymmetric 2D Gaussian convolved with a line – a model for a fast-moving, trailed-source (Veres et al.

2012).

VeresModel is designed to compute the chi-squared of the model given an lsst::afw::image::Exposure.

Definition at line 47 of file VeresModel.h.

Member Typedef Documentation

◆ ExposureF

Definition at line 50 of file VeresModel.h.

◆ ImageF

Definition at line 49 of file VeresModel.h.

Constructor & Destructor Documentation

◆ VeresModel() [1/3]

lsst::meas::extensions::trailedSources::VeresModel::VeresModel ( ExposureF const &  data)
explicit

Constructor for VeresModel.

Parameters
dataExposure passed from the measurement task.

Definition at line 39 of file VeresModel.cc.

◆ VeresModel() [2/3]

lsst::meas::extensions::trailedSources::VeresModel::VeresModel ( VeresModel const &  )
default

◆ VeresModel() [3/3]

lsst::meas::extensions::trailedSources::VeresModel::VeresModel ( VeresModel &&  )
default

◆ ~VeresModel()

lsst::meas::extensions::trailedSources::VeresModel::~VeresModel ( )
default

Member Function Documentation

◆ getSigma()

double lsst::meas::extensions::trailedSources::VeresModel::getSigma ( ) const
inlinenoexcept

Return the PSF sigma.

Definition at line 99 of file VeresModel.h.

◆ gradient()

std::vector< double > lsst::meas::extensions::trailedSources::VeresModel::gradient ( std::vector< double > const &  params) const

Compute the gradient of chi-squared of the model given the data.

Parameters
paramsModel parameters.
Returns
The gradient of chi-squared of the model with respect to the model parameters.
Note
The params vector contains the following model parameters:
  • Centroid x: X-coordinate of the centroid in given image [pixels].
  • Centroid y: Y-coordinate of the centroid in given image [pixels].
  • Flux: Total flux in the trail [count].
  • Length: Length of the trail [pixels].
  • Angle: Angle from the +x-axis [radians].

Definition at line 70 of file VeresModel.cc.

◆ operator()()

double lsst::meas::extensions::trailedSources::VeresModel::operator() ( std::vector< double > const &  params) const

Compute chi-squared of the model given the data.

Parameters
paramsModel parameters.
Returns
The chi-squared of the model.
Note
The params vector contains the following model parameters:
  • Centroid x: X-coordinate of the centroid in given image [pixels].
  • Centroid y: Y-coordinate of the centroid in given image [pixels].
  • Flux: Total flux in the trail [count].
  • Length: Length of the trail [pixels].
  • Angle: Angle from the +x-axis [radians].

Definition at line 46 of file VeresModel.cc.

◆ operator=() [1/2]

VeresModel& lsst::meas::extensions::trailedSources::VeresModel::operator= ( VeresModel &&  )
default

◆ operator=() [2/2]

VeresModel& lsst::meas::extensions::trailedSources::VeresModel::operator= ( VeresModel const &  )
default

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