Stack.h

Go to the documentation of this file.

// -*- lsst-c++ -*-

/*
 * LSST Data Management System
 * Copyright 2008, 2009, 2010 LSST Corporation.
 *
 * This product includes software developed by the
 * LSST Project (http://www.lsst.org/).
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the LSST License Statement and
 * the GNU General Public License along with this program.  If not,
 * see <http://www.lsstcorp.org/LegalNotices/>.
 */

#if !defined(LSST_AFW_MATH_STACK_H)
#define LSST_AFW_MATH_STACK_H
/*
 * Functions to stack images
 */
#include <vector>
#include "lsst/afw/image/Image.h"
#include "lsst/afw/image/Mask.h"
#include "lsst/afw/math/Statistics.h"

namespace lsst {
namespace afw {
namespace math {

/* ****************************************************************** *
 *
 * z stacks
 *
 * ******************************************************************* */

template <typename PixelT>
std::shared_ptr<lsst::afw::image::Image<PixelT>> statisticsStack(
        std::vector<std::shared_ptr<lsst::afw::image::Image<PixelT>>>& images,  
        Property flags,                                                         
        StatisticsControl const& sctrl = StatisticsControl(),                   
        std::vector<lsst::afw::image::VariancePixel> const& wvector =
                std::vector<lsst::afw::image::VariancePixel>(0)  
);

template <typename PixelT>
void statisticsStack(
        lsst::afw::image::Image<PixelT>& out,                                   
        std::vector<std::shared_ptr<lsst::afw::image::Image<PixelT>>>& images,  
        Property flags,                                                         
        StatisticsControl const& sctrl = StatisticsControl(),                   
        std::vector<lsst::afw::image::VariancePixel> const& wvector =
                std::vector<lsst::afw::image::VariancePixel>(0)  
);

template <typename PixelT>
std::shared_ptr<lsst::afw::image::MaskedImage<PixelT>> statisticsStack(
        std::vector<std::shared_ptr<lsst::afw::image::MaskedImage<PixelT>>>& images, Property flags,
        StatisticsControl const& sctrl, std::vector<lsst::afw::image::VariancePixel> const& wvector,
        image::MaskPixel clipped, std::vector<std::pair<image::MaskPixel, image::MaskPixel>> const& maskMap);

template <typename PixelT>
std::shared_ptr<lsst::afw::image::MaskedImage<PixelT>> statisticsStack(
        std::vector<std::shared_ptr<lsst::afw::image::MaskedImage<PixelT>>>&
                images,                                        
        Property flags,                                        
        StatisticsControl const& sctrl = StatisticsControl(),  
        std::vector<lsst::afw::image::VariancePixel> const& wvector =
                std::vector<lsst::afw::image::VariancePixel>(0),  
        image::MaskPixel clipped = 0,  
        image::MaskPixel excuse = 0    
);

template <typename PixelT>
void statisticsStack(lsst::afw::image::MaskedImage<PixelT>& out,
                     std::vector<std::shared_ptr<lsst::afw::image::MaskedImage<PixelT>>>& images,
                     Property flags, StatisticsControl const& sctrl,
                     std::vector<lsst::afw::image::VariancePixel> const& wvector, image::MaskPixel clipped,
                     std::vector<std::pair<image::MaskPixel, image::MaskPixel>> const& maskMap);

template <typename PixelT>
void statisticsStack(lsst::afw::image::MaskedImage<PixelT>& out,  
                     std::vector<std::shared_ptr<lsst::afw::image::MaskedImage<PixelT>>>&
                             images,                                        
                     Property flags,                                        
                     StatisticsControl const& sctrl = StatisticsControl(),  
                     std::vector<lsst::afw::image::VariancePixel> const& wvector =
                             std::vector<lsst::afw::image::VariancePixel>(0),  
                     image::MaskPixel clipped = 0,  
                     image::MaskPixel excuse = 0    
);

template <typename PixelT>
std::vector<PixelT> statisticsStack(
        std::vector<std::vector<PixelT>>& vectors,  
        Property flags,                                              
        StatisticsControl const& sctrl = StatisticsControl(),        
        std::vector<lsst::afw::image::VariancePixel> const& wvector =
                std::vector<lsst::afw::image::VariancePixel>(0)  
);

/* ****************************************************************** *
 *
 * x,y stacks
 *
 * ******************************************************************* */

template <typename PixelT>
std::shared_ptr<lsst::afw::image::MaskedImage<PixelT>> statisticsStack(
        lsst::afw::image::Image<PixelT> const& image, Property flags, char dimension,
        StatisticsControl const& sctrl = StatisticsControl());
template <typename PixelT>
std::shared_ptr<lsst::afw::image::MaskedImage<PixelT>> statisticsStack(
        lsst::afw::image::MaskedImage<PixelT> const& image, Property flags, char dimension,
        StatisticsControl const& sctrl = StatisticsControl());
}  // namespace math
}  // namespace afw
}  // namespace lsst

#endif