Logo Search packages:      
Sourcecode: cbflib version File versions  Download package

def pycbf::cbf_handle_struct::get_realarrayparameters (   args  ) 

Returns : int compression,int binary_id,int elsize,int elements
*args   : 

C prototype: int cbf_get_realarrayparameters (cbf_handle handle,
         unsigned int    *compression, int *binary_id, size_t *elsize,
         size_t *elements);

CBFLib documentation:
DESCRIPTION
cbf_get_integerarrayparameters sets *compression, *binary_id, 
*elsize, *elsigned, *elunsigned, *elements, *minelement and 
*maxelement to values read from the binary value of the item at the 
current column and row. This provides all the arguments needed for a 
subsequent call to cbf_set_integerarray, if a copy of the array is to 
be made into another CIF or CBF. cbf_get_realarrayparameters sets 
*compression, *binary_id, *elsize, *elements to values read from the 
binary value of the item at the current column and row. This provides 
all the arguments needed for a subsequent call to cbf_set_realarray, 
if a copy of the arry is to be made into another CIF or CBF.
The variants cbf_get_integerarrayparameters_wdims and 
cbf_get_realarrayparameters_wdims set **byteorder, *dim1, *dim2, 
*dim3, and *padding as well, providing the additional parameters 
needed for a subsequent call to cbf_set_integerarray_wdims or 
cbf_set_realarray_wdims.
The value returned in *byteorder is a pointer either to the string 
"little_endian" or to the string "big_endian". This should be the 
byte order of the data, not necessarily of the host machine. No 
attempt should be made to modify this string. At this time only 
"little_endian" will be returned.
The values returned in *dim1, *dim2 and *dim3 are the sizes of the 
fastest changing, second fastest changing and third fastest changing 
dimensions of the array, if specified, or zero, if not specified.
The value returned in *padding is the size of the post-data padding, 
if any and if specified in the data header. The value is given as a 
count of octets.
If the value is not binary, the function returns CBF_ASCII.
ARGUMENTS
handle   CBF handle. compression   Compression method used. elsize   
Size in bytes of each array element. binary_id   Pointer to the 
destination integer binary identifier. elsigned   Pointer to an 
integer. Set to 1 if the elements can be read as signed integers. 
elunsigned   Pointer to an integer. Set to 1 if the elements can be 
read as unsigned integers. elements   Pointer to the destination 
number of elements. minelement   Pointer to the destination smallest 
element. maxelement   Pointer to the destination largest element. 
byteorder   Pointer to the destination byte order. dim1   Pointer to 
the destination fastest dimension. dim2   Pointer to the destination 
second fastest dimension. dim3   Pointer to the destination third 
fastest dimension. padding   Pointer to the destination padding size.
RETURN VALUE
Returns an error code on failure or 0 for success.
SEE ALSO

Definition at line 791 of file pycbf.py.

00791                                       :
        """
        Returns : int compression,int binary_id,int elsize,int elements
        *args   : 

        C prototype: int cbf_get_realarrayparameters (cbf_handle handle,
                         unsigned int    *compression, int *binary_id, size_t *elsize,
                         size_t *elements);

        CBFLib documentation:
        DESCRIPTION
        cbf_get_integerarrayparameters sets *compression, *binary_id, 
        *elsize, *elsigned, *elunsigned, *elements, *minelement and 
        *maxelement to values read from the binary value of the item at the 
        current column and row. This provides all the arguments needed for a 
        subsequent call to cbf_set_integerarray, if a copy of the array is to 
        be made into another CIF or CBF. cbf_get_realarrayparameters sets 
        *compression, *binary_id, *elsize, *elements to values read from the 
        binary value of the item at the current column and row. This provides 
        all the arguments needed for a subsequent call to cbf_set_realarray, 
        if a copy of the arry is to be made into another CIF or CBF.
        The variants cbf_get_integerarrayparameters_wdims and 
        cbf_get_realarrayparameters_wdims set **byteorder, *dim1, *dim2, 
        *dim3, and *padding as well, providing the additional parameters 
        needed for a subsequent call to cbf_set_integerarray_wdims or 
        cbf_set_realarray_wdims.
        The value returned in *byteorder is a pointer either to the string 
        "little_endian" or to the string "big_endian". This should be the 
        byte order of the data, not necessarily of the host machine. No 
        attempt should be made to modify this string. At this time only 
        "little_endian" will be returned.
        The values returned in *dim1, *dim2 and *dim3 are the sizes of the 
        fastest changing, second fastest changing and third fastest changing 
        dimensions of the array, if specified, or zero, if not specified.
        The value returned in *padding is the size of the post-data padding, 
        if any and if specified in the data header. The value is given as a 
        count of octets.
        If the value is not binary, the function returns CBF_ASCII.
        ARGUMENTS
        handle   CBF handle. compression   Compression method used. elsize   
        Size in bytes of each array element. binary_id   Pointer to the 
        destination integer binary identifier. elsigned   Pointer to an 
        integer. Set to 1 if the elements can be read as signed integers. 
        elunsigned   Pointer to an integer. Set to 1 if the elements can be 
        read as unsigned integers. elements   Pointer to the destination 
        number of elements. minelement   Pointer to the destination smallest 
        element. maxelement   Pointer to the destination largest element. 
        byteorder   Pointer to the destination byte order. dim1   Pointer to 
        the destination fastest dimension. dim2   Pointer to the destination 
        second fastest dimension. dim3   Pointer to the destination third 
        fastest dimension. padding   Pointer to the destination padding size.
        RETURN VALUE
        Returns an error code on failure or 0 for success.
        SEE ALSO

        """
        return _pycbf.cbf_handle_struct_get_realarrayparameters(*args)


Generated by  Doxygen 1.6.0   Back to index