Interface ICompressParameters

    • Method Detail

      • addColumnsToTable

        void addColumnsToTable​(BinaryTableHDU hdu)
                        throws FitsException
        Add the columns that hold the metadata for the parameters that are column based to the dhu.
        Parameters:
        hdu - the hdu to add the column
        Throws:
        FitsException - if the column could not be added.
      • copy

        ICompressParameters copy​(ICompressOption option)
        create a copy of this parameter for another option (normally a copy of the current option).
        Parameters:
        option - the new option for the copied parameter
        Returns:
        this (builder pattern)
      • getValuesFromColumn

        void getValuesFromColumn​(int index)
        extract the option data from the column and set it in the option.
        Parameters:
        index - the index in the column.
      • getValuesFromHeader

        void getValuesFromHeader​(IHeaderAccess header)
        extract the option values that are represented by headers from the hdu header.
        Parameters:
        header - the header to extract the option values.
      • initializeColumns

        void initializeColumns​(IHeaderAccess header,
                               BinaryTable binaryTable,
                               int size)
                        throws FitsException
        initialize the column based options of the compression algorithm from the binary table.
        Parameters:
        header - the header of the hdu
        binaryTable - the table of the hdu
        size - the column size
        Throws:
        FitsException - if the column could not be initialized
      • initializeColumns

        void initializeColumns​(int length)
        initialize the column based parameter to the specified column length.
        Parameters:
        length - the column length.
      • setValueFromColumn

        void setValueFromColumn​(int index)
        set the option values, that are column based, into the columns at the specified index.
        Parameters:
        index - the index in the columns to set.
      • setValuesInHeader

        void setValuesInHeader​(IHeaderAccess header)
                        throws HeaderCardException
        set the options values, that are hdu based, into the header.
        Parameters:
        header - the header to set the option value
        Throws:
        HeaderCardException - if the header could not be set.