LSSTApplications  16.0-1-gce273f5+15,16.0-1-gf77f410+8,16.0-10-g230e10e+8,16.0-10-g5a5abec+4,16.0-10-gc1446dd+8,16.0-11-g5cf5345,16.0-12-g1dc09ba+2,16.0-12-g726f8f3+6,16.0-13-g4c33ca5+8,16.0-13-g5f6c0b1+8,16.0-13-gd9b1b71+8,16.0-14-g71e547a+4,16.0-17-g0bdc215,16.0-17-g6a7bfb3b+8,16.0-18-g95848a16+2,16.0-2-g0febb12+12,16.0-2-g839ba83+46,16.0-2-g9d5294e+35,16.0-3-g404ea43+7,16.0-3-gbc759ec+6,16.0-3-gcfd6c53+33,16.0-4-g03cf288+24,16.0-4-g13a27c5+10,16.0-4-g2cc461c+3,16.0-4-g5f3a788+11,16.0-4-g8a0f11a+30,16.0-4-ga3eb747+1,16.0-43-gaa65a4573+4,16.0-5-g1991253+8,16.0-5-g865efd9+8,16.0-5-gb3f8a4b+40,16.0-5-gd0f1235+4,16.0-6-g316b399+8,16.0-6-gf0acd13+27,16.0-6-gf9cb114+9,16.0-7-ga8e1655+4,16.0-8-g23bbf3f+1,16.0-8-g4dec96c+21,16.0-8-gfd407c0,w.2018.39
LSSTDataManagementBasePackage
Utils.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 //
26 //##====---------------- ----------------====##/
27 //
28 // Support for formatters
29 //
30 //##====---------------- ----------------====##/
31 
32 #include <cstdint>
33 #include <iostream>
34 #include <vector>
35 
36 #include "boost/format.hpp"
37 #include "lsst/pex/exceptions.h"
38 #include "lsst/pex/policy/Policy.h"
42 
43 using std::int64_t;
44 namespace ex = lsst::pex::exceptions;
48 
49 namespace lsst {
50 namespace afw {
51 namespace formatters {
52 
54  if (properties->isArray("sliceId")) {
55  throw LSST_EXCEPT(ex::RuntimeError, "\"sliceId\" property has multiple values");
56  }
57  int sliceId = properties->getAsInt("sliceId");
58  if (sliceId < 0) {
59  throw LSST_EXCEPT(ex::RangeError, "negative \"sliceId\"");
60  }
61  if (properties->exists("universeSize") && !properties->isArray("universeSize")) {
62  int universeSize = properties->getAsInt("universeSize");
63  if (sliceId >= universeSize) {
64  throw LSST_EXCEPT(ex::RangeError, "\"sliceId\" must be less than \"universeSize \"");
65  }
66  }
67  return sliceId;
68 }
69 
71  if (properties->isArray("visitId")) {
72  throw LSST_EXCEPT(ex::RuntimeError, "\"visitId\" property has multiple values");
73  }
74  int visitId = properties->getAsInt("visitId");
75  if (visitId < 0) {
76  throw LSST_EXCEPT(ex::RangeError, "negative \"visitId\"");
77  }
78  return visitId;
79 }
80 
82  if (properties->isArray("fpaExposureId")) {
83  throw LSST_EXCEPT(ex::RuntimeError, "\"fpaExposureId\" property has multiple values");
84  }
85  int64_t fpaExposureId = properties->getAsInt64("fpaExposureId");
86  if (fpaExposureId < 0) {
87  throw LSST_EXCEPT(ex::RangeError, "negative \"fpaExposureId\"");
88  }
89  if ((fpaExposureId & 0xfffffffe00000000LL) != 0LL) {
90  throw LSST_EXCEPT(ex::RangeError, "\"fpaExposureId\" is too large");
91  }
92  return fpaExposureId;
93 }
94 
96  if (properties->isArray("ccdId")) {
97  throw LSST_EXCEPT(ex::RuntimeError, "\"ccdId\" property has multiple values");
98  }
99  int ccdId = properties->getAsInt("ccdId");
100  if (ccdId < 0) {
101  throw LSST_EXCEPT(ex::RangeError, "negative \"ccdId\"");
102  }
103  if (ccdId > 255) {
104  throw LSST_EXCEPT(ex::RangeError, "\"ccdId\" is too large");
105  }
106  return static_cast<int>(ccdId);
107 }
108 
110  if (properties->isArray("ampId")) {
111  throw LSST_EXCEPT(ex::RuntimeError, "\"ampId\" property has multiple values");
112  }
113  int ampId = properties->getAsInt("ampId");
114  if (ampId < 0) {
115  throw LSST_EXCEPT(ex::RangeError, "negative \"ampId\"");
116  }
117  if (ampId > 63) {
118  throw LSST_EXCEPT(ex::RangeError, "\"ampId\" is too large");
119  }
120  return (extractCcdId(properties) << 6) + ampId;
121 }
122 
124  if (properties->isArray("ccdExposureId")) {
125  throw LSST_EXCEPT(ex::RuntimeError, "\"ccdExposureId\" property has multiple values");
126  }
127  int64_t ccdExposureId = properties->getAsInt64("ccdExposureId");
128  if (ccdExposureId < 0) {
129  throw LSST_EXCEPT(ex::RangeError, "negative \"ccdExposureId\"");
130  }
131  return ccdExposureId;
132 }
133 
135  if (properties->isArray("ampExposureId")) {
136  throw LSST_EXCEPT(ex::RuntimeError, "\"ampExposureId\" property has multiple values");
137  }
138  int64_t ampExposureId = properties->getAsInt64("ampExposureId");
139  if (ampExposureId < 0) {
140  throw LSST_EXCEPT(ex::RangeError, "negative \"ampExposureId\"");
141  }
142  return ampExposureId;
143 }
144 
146  if (!properties) {
147  throw LSST_EXCEPT(ex::InvalidParameterError, "Null std::shared_ptr<PropertySet>");
148  }
149  if (properties->isArray("itemName")) {
150  throw LSST_EXCEPT(ex::InvalidParameterError, "\"itemName\" property has multiple values");
151  }
152  return properties->getAsString("itemName");
153 }
154 
156  if (properties && properties->exists(name)) {
157  return properties->getAsBool(name);
158  }
159  return false;
160 }
161 
163  std::shared_ptr<PropertySet const> const& properties) {
164  std::string itemName(getItemName(properties));
165  return LogicalLocation(policy->getString(itemName + ".tableNamePattern"), properties).locString();
166 }
167 
169  std::shared_ptr<PropertySet const> const& properties) {
170  std::string itemName(getItemName(properties));
171  std::string pattern(policy->getString(itemName + ".tableNamePattern"));
172  int numSlices = 1;
173  if (properties->exists(itemName + ".numSlices")) {
174  numSlices = properties->getAsInt(itemName + ".numSlices");
175  }
176  if (numSlices <= 0) {
177  throw LSST_EXCEPT(ex::RuntimeError, itemName + " \".numSlices\" property value must be positive");
178  }
180  names.reserve(numSlices);
181  std::shared_ptr<PropertySet> props = properties->deepCopy();
182  for (int i = 0; i < numSlices; ++i) {
183  props->set("sliceId", i);
184  names.push_back(LogicalLocation(pattern, props).locString());
185  }
186  return names;
187 }
188 
189 int countFitsHeaderCards(lsst::daf::base::PropertySet const& prop) { return prop.paramNames(false).size(); }
190 
191 ndarray::Array<std::uint8_t, 1, 1> stringToBytes(std::string const& str) {
192  auto nbytes = str.size() * sizeof(char) / sizeof(std::uint8_t);
193  std::uint8_t const* byteCArr = reinterpret_cast<std::uint8_t const*>(str.data());
194  auto shape = ndarray::makeVector(nbytes);
195  auto strides = ndarray::makeVector(1);
196  // Make an Array that shares memory with `str` (and does not free that memory when destroyed),
197  // then return a copy; this is simpler than manually copying the data into a newly allocated array
198  ndarray::Array<std::uint8_t const, 1, 1> localArray = ndarray::external(byteCArr, shape, strides);
199  return ndarray::copy(localArray);
200 }
201 
202 std::string bytesToString(ndarray::Array<std::uint8_t const, 1, 1> const& bytes) {
203  auto nchars = bytes.size() * sizeof(std::uint8_t) / sizeof(char);
204  char const* charCArr = reinterpret_cast<char const*>(bytes.getData());
205  return std::string(charCArr, nchars);
206 }
207 
208 } // namespace formatters
209 } // namespace afw
210 } // namespace lsst
std::string const getItemName(std::shared_ptr< lsst::daf::base::PropertySet const > const &properties)
Extracts and returns the string-valued "itemName" property from the given data property object...
Definition: Utils.cc:145
bool extractOptionalFlag(std::shared_ptr< lsst::daf::base::PropertySet const > const &properties, std::string const &name)
Returns true if and only if properties is non-null and contains a unique property with the given name...
Definition: Utils.cc:155
std::string const getTableName(std::shared_ptr< lsst::pex::policy::Policy const > const &policy, std::shared_ptr< lsst::daf::base::PropertySet const > const &properties)
Returns the name of the table that a single slice of a pipeline involved in the processing of a singl...
Definition: Utils.cc:162
Class for logical location of a persisted Persistable instance.
a container for holding hierarchical configuration data in memory.
Definition: Policy.h:169
int extractAmpId(std::shared_ptr< lsst::daf::base::PropertySet const > const &properties)
Definition: Utils.cc:109
int extractSliceId(std::shared_ptr< lsst::daf::base::PropertySet const > const &properties)
Definition: Utils.cc:53
std::vector< std::string > paramNames(bool topLevelOnly=true) const
A variant of names that excludes the names of subproperties.
int64_t extractCcdExposureId(std::shared_ptr< lsst::daf::base::PropertySet const > const &properties)
Definition: Utils.cc:123
std::string bytesToString(ndarray::Array< std::uint8_t const, 1, 1 > const &bytes)
Decode a std::string from a vector of uint8 returned by stringToBytes.
Definition: Utils.cc:202
STL class.
int64_t extractFpaExposureId(std::shared_ptr< lsst::daf::base::PropertySet const > const &properties)
Definition: Utils.cc:81
T push_back(T... args)
int extractVisitId(std::shared_ptr< lsst::daf::base::PropertySet const > const &properties)
Definition: Utils.cc:70
T data(T... args)
int64_t extractAmpExposureId(std::shared_ptr< lsst::daf::base::PropertySet const > const &properties)
Definition: Utils.cc:134
A base class for image defects.
Definition: cameraGeom.dox:3
int extractCcdId(std::shared_ptr< lsst::daf::base::PropertySet const > const &properties)
Definition: Utils.cc:95
int countFitsHeaderCards(lsst::daf::base::PropertySet const &prop)
Definition: Utils.cc:189
table::Key< table::Array< std::uint8_t > > bytes
Definition: Transform.cc:199
std::vector< std::string > getAllSliceTableNames(std::shared_ptr< lsst::pex::policy::Policy const > const &policy, std::shared_ptr< lsst::daf::base::PropertySet const > const &properties)
Stores the name of the table that each slice of a pipeline involved in processing a visit used for pe...
Definition: Utils.cc:168
T size(T... args)
#define LSST_EXCEPT(type,...)
Create an exception with a given type.
Definition: Exception.h:48
Class for storing generic metadata.
Definition: PropertySet.h:73
Reports invalid arguments.
Definition: Runtime.h:66
ndarray::Array< std::uint8_t, 1, 1 > stringToBytes(std::string const &str)
Encode a std::string as a vector of uint8.
Definition: Utils.cc:191
Interface for LogicalLocation class.
Reports when the result of an operation cannot be represented by the destination type.
Definition: Runtime.h:115
T reserve(T... args)
Reports errors that are due to events beyond the control of the program.
Definition: Runtime.h:104