2pck

From XDSwiki
Revision as of 13:36, 9 November 2010 by Kay (talk | contribs) (add stoe and cbf - they should work as well)
Jump to navigation Jump to search

2pck is a program that used to be distributed with versions of XDS until the end of 2008. It serves to convert frames from a number of formats into the CCP4 "pck" compressed file format. Since version January-2009, 2pck has been superseded by the 2cbf program. However, there are detector types supported by 2pck that are not supported by either 2cbf or XDS itself. For those (e.g. SMARTCCD, MAC) it might make sense to convert the frames to pck format which also the latest XDS can read.

A Linux binary of 2pck is here.

This is a sample 2PCK.INP:

!*****************************************************************************
! File 2PCK.INP  contains named arguments for running program 2pck.
! Characters in a line to the right of an exclamation mark are comment.
!*****************************************************************************
!********* Example for SMARTCCD detector at BASF Ludwigshafen       **********
!*****************************************************************************
!Supported detectors are:
!   SIEMENS  - (Siemens/Nicolet) multiwire detector
!    MAR     - marresearch (X-ray Research) imaging plate detector (old)
!  MAR345    - marresearch (X-ray Research) imaging plate detector (new)
!   RAXIS    - R-AXIS2 imaging plate detector
!    MAC     - MacScience imaging plate detector, ENRAF NONIUS DIP-series
!  CCDD2AM   - CCD-detector at ESRF Grenoble (beamline D2AM)
!   ESRF     - CCD-detector at ESRF Grenoble (beamline 3)
! VIDEMETRIX - CCD-detector at Brandeis (designed by Walter Phillips)
!  CCDCHESS  - CCD-detector at CHESS and MAR CCD-detector at BROOKHAVEN
!  SMARTCCD  - Bruker CCD detector
!
!Number of detector pixels along X & Y and their sizes; OVERLOAD is
!the maximum valid pixel contents accepted for integration in PROFIT
!For the MAR345 number of detector pixels and their sizes are implied by
!the image file name extensions (like .mar2300 or .pck2300).
!            -   NX=    NY=     pixel size(mm)   OVERLOAD=
!   SIEMENS  -   512    512   QX=0.19   QY=0.19    65000
!    MAR     -  1200   1200   QX=0.15   QY=0.15   130000
!    MAR     -  2000   2000   QX=0.15   QY=0.15   130000
!  MAR345    -  2300   2300   QX=0.15   QY=0.15   130000   .mar2300 or .pck2300
!  MAR345    -  2000   2000   QX=0.15   QY=0.15   130000   .mar2000 or .pck2000
!  MAR345    -  1600   1600   QX=0.15   QY=0.15   130000   .mar1600 or .pck1600
!  MAR345    -  1200   1200   QX=0.15   QY=0.15   130000   .mar1200 or .pck1200
!  MAR345    -  3450   3450   QX=0.10   QY=0.10   130000   .mar3450 or .pck3450
!  MAR345    -  3000   3000   QX=0.10   QY=0.10   130000   .mar3000 or .pck3000
!  MAR345    -  2400   2400   QX=0.10   QY=0.10   130000   .mar2400 or .pck2400
!  MAR345    -  1800   1800   QX=0.10   QY=0.10   130000   .mar1800 or .pck1800
!   RAXIS    -  1900   1900   QX=0.1017 QY=0.105  250000
!   RAXIS    -   950    950   QX=0.2034 QY=0.210  250000
!    MAC     -  2500   2500   QX=0.08   QY=0.08   250000    DIP2020
!    MAC     -  3000   3000   QX=0.10   QY=0.10   250000    DIP2030
!  CCDD2AM   -  1242   1152   QX=0.191  QY=0.191   65000
!   ESRF     -  1242   1152   QX=0.1298 QY=0.129   65000
! VIDEMETRIX -   512    512   QX=0.1369 QY=0.136    4095
!  CCDDCHESS -  1024   1024   QX=0.0508 QY=0.050   63000
!   MARCCD   -  2048   2048   QX=0.064  QY=0.064   65000
! CCDBRANDEIS-  1024   1024   QX=0.1000 QY=0.100   42000
!  SMARTCCD  -  1024   1024   QX=0.089  QY=0.089  250000
!  SMARTCCD  -  2048   2048   QX=0.1785 QY=0.1785 250000
!     STOE (the original 2PCK.INP does not have this but it should work)
!     CBF  (the original 2PCK.INP does not have this but it should work)
!*****************************************************************************
! Acceptable format KEYWORDS are:
! HARVARD  ARGONNE  : SIEMENS multiwire detector
! MAR               : marresearch-detector
! MAR345            : New MAR345 image format
! RAXIS             : R-AXISII or R-AXISIV detector
! MAC               : MacScience (ENRAF NONIUS) imaging plate detector
!                     for both 12-bit (DIP2020) and 16-bit (DIP2030)
! VIDEMETRIX        : CCD-detector designed by Walter Phillips
! CCDD2AM           : CCD-detector at ESRF Grenoble
! ESRF              : Format of another CCD-detector at ESRF
! CCP4              : Compressed images by Jan Pieter Abrahams
!                     algorithm with number representation used at MRC
! TIFF              : TIFF-format
! CCDBRANDEIS       : CCD-detector (1024 X 1024) at Brandeis & Brookhaven
! BRUKER            : Bruker area detector frame data format
! SMV               : ADSC CCD-detector frame data format
! STOE              : (the original 2PCK.INP does not have this but it should work)
! CBF               : Pilatus (the original 2PCK.INP does not have this but it should work)

!Generic file name, access, and format of data frames to be converted
NAME_TEMPLATE_OF_DATA_FRAMES=../lysocust/lyz0.??? DIRECT BRUKER
!Numbers of first and last data frame to be converted
DATA_RANGE=  1 500
!Number of detector pixels along X, Y
NX=1024 NY=1024

!Generic file name of output data frames. File access and type are fixed
!by the program ("2pck") as DIRECT and CCP4, respectively.
NAME_TEMPLATE_OF_OUTPUT_FRAMES=../lysocust/lyz0_???.pck

!This optional parameter value allows you to add a fixed number of
!adjacent input frames for each output frame. (default=1)
!NUMBER_OF_DATA_FRAMES_COVERED_BY_EACH_OUTPUT_FRAME=1