Changeset 6732 for trunk/doc/pslib/psLibSDRS.tex

Timestamp:

Mar 29, 2006, 5:36:41 PM (20 years ago)

Author:

Paul Price

Message:

Added psMetadataItemCopy, psRegionAlloc, PS_DATA_REGION.

File:

• trunk/doc/pslib/psLibSDRS.tex (modified) (4 diffs)

trunk/doc/pslib/psLibSDRS.tex

@@ -1 @@
-%%% $Id: psLibSDRS.tex,v 1.388 2006-03-17 00:05:48 eugene Exp $
+%%% $Id: psLibSDRS.tex,v 1.389 2006-03-30 03:36:41 price Exp $
 \documentclass[panstarrs,spec]{panstarrs}
 
@@ -982 +982 @@
     PS_DATA_POLYNOMIAL4D,              ///< psPolynomial4D
     PS_DATA_PROJECTION,                ///< psProjection
+    PS_DATA_REGION,                    ///< psRegion
     PS_DATA_SCALAR,                    ///< psScalar
     PS_DATA_SPHERE,                    ///< psSphere
@@ -2902 +2903 @@
 header.
 \begin{prototype}
+psMetadataItem *psMetadataItemCopy(const psMetadataItem *in);
 psMetadata *psMetadataCopy(psMetadata *out, const psMetadata *in);
 \end{prototype}
+\code{psMetadataItemCopy} shall create a new copy of the input
+\code{psMetadataItem}.  Since it is not feasible (at this time) to be
+able to copy every type, data of the standard numeric types plus
+\code{PS_DATA_VECTOR}, \code{PS_DATA_TIME}, \code{PS_DATA_METADATA}
+and \code{PS_DATA_REGION} shall be copied; other pointer types may
+simply be copied with a warning \tbd{for now}.
+
 \code{psMetadataCopy} shall create a new copy of all
 \code{psMetadataItem}s in the \code{in} metadata, and place them in
 the \code{out} metadata, or a new \code{psMetadata} if \code{out} is
-\code{NULL}.  Now, it is not feasible (at this time) to be able to
-copy every type that we might put on a \code{psMetadata}.  Therefore,
-\code{psMetadataCopy} shall copy only the numerical types and strings.
-Other pointer types may simply have the pointer copied (with the
-reference counter incremented appropriately), with the total number of
-such copies (if positive) reported in a warning at the end of the
-function.
+\code{NULL}.
 
 \subsubsection{Configuration files}
@@ -3634 +3637 @@
 floats, and is defined statically.  Functions which accept or return a
 \code{psRegion} shall do so by value, not by pointer.
+
+In the limited cases where we wish to store a \code{psRegion} on one
+of the containers, we need an attached \code{psMemBlock}, which can
+be obtained by calling \code{psRegionAlloc}:
+\begin{prototype}
+psRegion *psRegionAlloc(float x0, float x1, float y0, float y1);
+\end{prototype}
 
 All functions which use a \code{psRegion} must interpret the