LSSTApplications  20.0.0
LSSTDataManagementBasePackage
KernelPersistenceHelper.cc
Go to the documentation of this file.
1 // -*- LSST-C++ -*-
2 
3 /*
4  * LSST Data Management System
5  * Copyright 2008, 2009, 2010 LSST Corporation.
6  *
7  * This product includes software developed by the
8  * LSST Project (http://www.lsst.org/).
9  *
10  * This program is free software: you can redistribute it and/or modify
11  * it under the terms of the GNU General Public License as published by
12  * the Free Software Foundation, either version 3 of the License, or
13  * (at your option) any later version.
14  *
15  * This program is distributed in the hope that it will be useful,
16  * but WITHOUT ANY WARRANTY; without even the implied warranty of
17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18  * GNU General Public License for more details.
19  *
20  * You should have received a copy of the LSST License Statement and
21  * the GNU General Public License along with this program. If not,
22  * see <http://www.lsstcorp.org/LegalNotices/>.
23  */
24 
25 #include "lsst/pex/exceptions.h"
26 #include "lsst/afw/math/Kernel.h"
28 
29 namespace lsst {
30 namespace afw {
31 namespace math {
32 
34  : schema(),
35  dimensions(afw::table::PointKey<int>::addFields(schema, "dimensions",
36  "dimensions of a Kernel's images", "pixel")),
37  center(afw::table::PointKey<int>::addFields(schema, "center", "center point in a Kernel image",
38  "pixel")) {
39  if (nSpatialFunctions > 0) {
41  "spatialfunctions", "archive IDs for the Kernel's spatial functions", nSpatialFunctions);
42  }
43 }
44 
46  : schema(schema_), dimensions(schema["dimensions"]), center(schema["center"]) {
47  try {
48  spatialFunctions = schema["spatialfunctions"];
49  } catch (...) {
50  }
51 }
52 
54  afw::table::io::OutputArchiveHandle& handle, Kernel const& kernel) const {
55  afw::table::BaseCatalog catalog = handle.makeCatalog(schema);
57  record->set(dimensions, lsst::geom::Point2I(kernel.getDimensions()));
58  record->set(center, kernel.getCtr());
59  if (spatialFunctions.isValid()) {
60  writeSpatialFunctions(handle, *record, kernel._spatialFunctionList);
61  }
62  handle.saveCatalog(catalog);
63  return record;
64 }
65 
68  std::vector<std::shared_ptr<Kernel::SpatialFunction>> const& spatialFunctionList) const {
69  ndarray::Array<int, 1, 1> array = record[spatialFunctions];
70  for (std::size_t n = 0; n < spatialFunctionList.size(); ++n) {
71  array[n] = handle.put(spatialFunctionList[n]);
72  }
73 }
74 
76  afw::table::io::InputArchive const& archive, afw::table::BaseRecord const& record) const {
77  ndarray::Array<int const, 1, 1> array = record[spatialFunctions];
78  std::vector<std::shared_ptr<Kernel::SpatialFunction>> spatialFunctionList(array.getSize<0>());
79  for (std::size_t n = 0; n < spatialFunctionList.size(); ++n) {
80  spatialFunctionList[n] = archive.get<SpatialFunction>(array[n]);
81  LSST_ARCHIVE_ASSERT(array[n] == 0 || (spatialFunctionList[n]));
82  }
83  return spatialFunctionList;
84 }
85 } // namespace math
86 } // namespace afw
87 } // namespace lsst
schema
table::Schema schema
Definition: Amplifier.cc:115
std::shared_ptr
STL class.
lsst::afw::table::Schema::addField
Key< T > addField(Field< T > const &field, bool doReplace=false)
Add a new field to the Schema, and return the associated Key.
Definition: Schema.cc:668
lsst::afw::math::Kernel::getDimensions
lsst::geom::Extent2I const getDimensions() const
Return the Kernel's dimensions (width, height)
Definition: Kernel.h:213
lsst::afw::math::Kernel::PersistenceHelper::readSpatialFunctions
std::vector< SpatialFunctionPtr > readSpatialFunctions(afw::table::io::InputArchive const &archive, afw::table::BaseRecord const &record) const
Definition: KernelPersistenceHelper.cc:75
lsst::afw::table::io::OutputArchiveHandle
An object passed to Persistable::write to allow it to persist itself.
Definition: OutputArchive.h:118
std::vector
STL class.
std::vector::size
T size(T... args)
lsst::afw::table::io::OutputArchiveHandle::saveCatalog
void saveCatalog(BaseCatalog const &catalog)
Save a catalog in the archive.
Definition: OutputArchive.cc:211
lsst::afw
Definition: imageAlgorithm.dox:1
lsst::afw::table::io::InputArchive
A multi-catalog archive object used to load table::io::Persistable objects.
Definition: InputArchive.h:31
lsst::afw::table::Schema
Defines the fields and offsets for a table.
Definition: Schema.h:50
lsst::afw::math::Kernel::PersistenceHelper::PersistenceHelper
PersistenceHelper(int nSpatialFunctions)
Definition: KernelPersistenceHelper.cc:33
lsst::afw::math::Kernel::getCtr
lsst::geom::Point2I getCtr() const
Return index of kernel's center.
Definition: Kernel.h:235
lsst::afw::math::Kernel::PersistenceHelper::write
std::shared_ptr< afw::table::BaseRecord > write(afw::table::io::OutputArchiveHandle &handle, Kernel const &kernel) const
Definition: KernelPersistenceHelper.cc:53
lsst::afw::math::Kernel::PersistenceHelper::writeSpatialFunctions
void writeSpatialFunctions(afw::table::io::OutputArchiveHandle &handle, afw::table::BaseRecord &record, std::vector< SpatialFunctionPtr > const &spatialFunctionList) const
Definition: KernelPersistenceHelper.cc:66
lsst::afw::table::io::OutputArchiveHandle::makeCatalog
BaseCatalog makeCatalog(Schema const &schema)
Return a new, empty catalog with the given schema.
Definition: OutputArchive.cc:207
LSST_ARCHIVE_ASSERT
#define LSST_ARCHIVE_ASSERT(EXPR)
An assertion macro used to validate the structure of an InputArchive.
Definition: Persistable.h:48
lsst::afw::table::BaseRecord
Base class for all records.
Definition: BaseRecord.h:31
lsst::afw::table::Array
Tag types used to declare specialized field types.
Definition: misc.h:32
dimensions
afw::table::PointKey< int > dimensions
Definition: GaussianPsf.cc:49
lsst
A base class for image defects.
Definition: imageAlgorithm.dox:1
lsst::afw::math::Kernel::_spatialFunctionList
std::vector< SpatialFunctionPtr > _spatialFunctionList
Definition: Kernel.h:496
lsst::afw::math::Function2< double >
KernelPersistenceHelper.h
lsst::afw::math::Kernel::PersistenceHelper::schema
afw::table::Schema schema
Definition: KernelPersistenceHelper.h:40
Kernel.h
lsst::geom::Point< int, 2 >
std::size_t
lsst::afw::math::Kernel
Kernels are used for convolution with MaskedImages and (eventually) Images.
Definition: Kernel.h:111
lsst::afw::math::Kernel::PersistenceHelper::spatialFunctions
afw::table::Key< afw::table::Array< int > > spatialFunctions
Definition: KernelPersistenceHelper.h:43
lsst::afw::table::io::OutputArchiveHandle::put
int put(Persistable const *obj, bool permissive=false)
Save an object to the archive and return a unique ID that can be used to retrieve it from an InputArc...
Definition: OutputArchive.cc:216
lsst::afw::table::CatalogT::addNew
std::shared_ptr< RecordT > addNew()
Create a new record, add it to the end of the catalog, and return a pointer to it.
Definition: Catalog.h:485
lsst::afw::table::CatalogT< BaseRecord >
exceptions.h
lsst::afw::table::io::InputArchive::get
std::shared_ptr< Persistable > get(int id) const
Load the Persistable with the given ID and return it.
Definition: InputArchive.cc:182