27.01.2015 Views

CCfits - HEASARC - NASA

CCfits - HEASARC - NASA

CCfits - HEASARC - NASA

SHOW MORE
SHOW LESS

Create successful ePaper yourself

Turn your PDF publications into a flip-book with our unique Google optimized e-Paper software.

24.39 <strong>CCfits</strong>::PHDU Class Reference 131<br />

Parameters<br />

readFlag read the image data if true<br />

key a vector of strings of keyword names to be read from the primary HDU<br />

24.39.3.6 void <strong>CCfits</strong>::PHDU::scale ( double value ) [virtual]<br />

set the BSCALE keyword value for images (see warning for images of int type)<br />

For primary HDUs and image extensions, this will add (or update) the BSCALE keyword<br />

in the header. The new setting will affect future image array read/writes as described<br />

in section 4.7 Data Scaling of the CFITSIO manual. For table extensions this<br />

function does nothing.<br />

WARNING: If the image contains integer-type data (as indicated by the bitpix() return<br />

value), the new scale and zero value combination must not be such that the scaled<br />

data would require a floating-point type (this uses the CFITSIO function fits_get_img-<br />

_equivtype to make the determination). If this situation occurs, the function will throw<br />

a FitsException.<br />

Reimplemented from <strong>CCfits</strong>::HDU.<br />

24.39.3.7 template void <strong>CCfits</strong>::PHDU::write ( const std::vector< long > &<br />

first, long nElements, const std::valarray< S > & data, S ∗ nullValue )<br />

Write a set of pixels to an image extension with the first pixel specified by an n-tuple,<br />

processing undefined data.<br />

All the overloaded versions of PHDU::write perform operations on ∗this if it is an<br />

image and throw a WrongExtensionType exception if not. Where appropriate, alternate<br />

versions allow undefined data to be processed<br />

Parameters<br />

first an n-tuple of dimension equal to the image dimension specifying the<br />

first pixel in the range to be written<br />

nElements number of pixels to be written<br />

data array of data to be written<br />

nullValue pointer to null value (data with this value written as undefined; needs<br />

the BLANK keyword to have been specified).<br />

24.39.3.8 template void <strong>CCfits</strong>::PHDU::write ( long first, long nElements, const<br />

std::valarray< S > & data, S ∗ nullValue )<br />

write array to image starting with a specified pixel and allowing undefined data to be<br />

processed<br />

parameters after the first are as for version with n-tuple specifying first element. these<br />

two version are equivalent, except that it is possible for the first pixel number to exceed<br />

Generated on Tue Dec 6 2011 16:12:51 for <strong>CCfits</strong> by Doxygen

Hooray! Your file is uploaded and ready to be published.

Saved successfully!

Ooh no, something went wrong!