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

def pycbf::cbf_handle_struct::set_integerarray (   args  ) 

Returns : 
*args   : int compression,int binary_id,(binary) String data,int elsize,
  int elsigned,int elements

C prototype: int cbf_set_integerarray (cbf_handle handle,
         unsigned int compression,    int binary_id, void *array,
         size_t elsize, int elsigned, size_t    elements);

CBFLib documentation:
DESCRIPTION
cbf_set_integerarray sets the binary value of the item at the current 
column and row to an integer array. The array consists of elements 
elements of elsize bytes each, starting at array. The elements are 
signed if elsigned is non-0 and unsigned otherwise. binary_id is the 
binary section identifier. cbf_set_realarray sets the binary value of 
the item at the current column and row to an integer array. The array 
consists of elements elements of elsize bytes each, starting at 
array. binary_id is the binary section identifier.
The cbf_set_integerarray_wdims and cbf_set_realarray_wdims allow the 
data header values of byteorder, dim1, dim2, dim3 and padding to be 
set to the data byte order, the fastest, second fastest and third 
fastest array dimensions and the size in byte of the post data 
padding to be used.
The array will be compressed using the compression scheme specifed by 
compression. Currently, the available schemes are:
CBF_CANONICAL   Canonical-code compression (section 3.3.1) CBF_PACKED 
  CCP4-style packing (section 3.3.2) CBF_PACKED_V2   CCP4-style 
packing, version 2 (section 3.3.2) CBF_BYTE_OFFSET   Simple 
"byte_offset" compression. CBF_NONE   No compression. NOTE: This 
scheme is by far the slowest of the four and uses much more disk 
space. It is intended for routine use with small arrays only. With 
large arrays (like images) it should be used only for debugging.
The values compressed are limited to 64 bits. If any element in the 
array is larger than 64 bits, the value compressed is the nearest 
64-bit value.

Definition at line 3123 of file pycbf.py.

03123                                :
        """
        Returns : 
        *args   : int compression,int binary_id,(binary) String data,int elsize,
                  int elsigned,int elements

        C prototype: int cbf_set_integerarray (cbf_handle handle,
                         unsigned int compression,    int binary_id, void *array,
                         size_t elsize, int elsigned, size_t    elements);

        CBFLib documentation:
        DESCRIPTION
        cbf_set_integerarray sets the binary value of the item at the current 
        column and row to an integer array. The array consists of elements 
        elements of elsize bytes each, starting at array. The elements are 
        signed if elsigned is non-0 and unsigned otherwise. binary_id is the 
        binary section identifier. cbf_set_realarray sets the binary value of 
        the item at the current column and row to an integer array. The array 
        consists of elements elements of elsize bytes each, starting at 
        array. binary_id is the binary section identifier.
        The cbf_set_integerarray_wdims and cbf_set_realarray_wdims allow the 
        data header values of byteorder, dim1, dim2, dim3 and padding to be 
        set to the data byte order, the fastest, second fastest and third 
        fastest array dimensions and the size in byte of the post data 
        padding to be used.
        The array will be compressed using the compression scheme specifed by 
        compression. Currently, the available schemes are:
        CBF_CANONICAL   Canonical-code compression (section 3.3.1) CBF_PACKED 
          CCP4-style packing (section 3.3.2) CBF_PACKED_V2   CCP4-style 
        packing, version 2 (section 3.3.2) CBF_BYTE_OFFSET   Simple 
        "byte_offset" compression. CBF_NONE   No compression. NOTE: This 
        scheme is by far the slowest of the four and uses much more disk 
        space. It is intended for routine use with small arrays only. With 
        large arrays (like images) it should be used only for debugging.
        The values compressed are limited to 64 bits. If any element in the 
        array is larger than 64 bits, the value compressed is the nearest 
        64-bit value.

        """
        return _pycbf.cbf_handle_struct_set_integerarray(*args)


Generated by  Doxygen 1.6.0   Back to index