User Tools

Site Tools


main:samplepackunpack

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revision Previous revision
Next revision
Previous revision
Last revision Both sides next revision
main:samplepackunpack [2017/08/25 16:04]
bshirley
main:samplepackunpack [2017/08/25 19:56]
yli [Sample components]
Line 3: Line 3:
  
 In the event a [[main:sample | sample]] must be moved from one computer to another, multiple components of the sample must be transferred to the destination computer. Sample packing/unpacking provides functionality to simplify this process. In the event a [[main:sample | sample]] must be moved from one computer to another, multiple components of the sample must be transferred to the destination computer. Sample packing/unpacking provides functionality to simplify this process.
 +
 +===== Sample components =====
 +  * **Saved sample file**\\ This file is created when a processed sample is saved and has extension ".adcisample". By default it is found in the ADCI data directory specified during [[main:installation | installation]]. It contains - among other things - the status (other object, monocentric chromosome, dicentric chromosome) of all objects found within each image in the sample. This file is required when including the sample in [[main:calibrationcurve | calibration curve]] generation or [[main:estimatedose | dose estimation]]. This is the only sample component necessary to use ADCI if viewing images in the [[main:metaphaseimgviewer | metaphase image viewer]] is not required.
 +  * **Contour files**\\ A component of a [[main:processedsample | processed sample]] which are necessary to draw the colored outlines around chromosomes seen in the [[main:metaphaseimgviewer | metaphase image viewer]]. If contour files are not present, images will not appear in the metaphase image viewer. 
 +  * **Image files**\\ Images which were examined during sample processing. If image files are not present, images will not appear in the [[main:metaphaseimgviewer | metaphase image viewer]].  
  
 ===== Pack (export) sample ===== ===== Pack (export) sample =====
- 
  
 <WRAP group> <WRAP group>
 <WRAP column half> <WRAP column half>
 +
 +  * **Sample ID**\\ Cannot be modified. ID of sample to be packed.
 +  * **Description**\\ Description of the sample as specified when the sample was created. The description can be modified at this time if desired. When the sample is packed, the description saved within the packed sample will consist of the content found in the description text box here.
 +  * **Contour files status / Metaphase images status**\\ If ADCI cannot locate either of these sample components, the status of the missing component is "missing", otherwise it is "found".
 +  * **Pack Sample As Folder**\\ Click "Specify Folder" to choose a file-system location where the packed sample will be saved. A new directory named "[ID of sample]pack" will be automatically created within the chosen directory to house the packed sample.
 +  * **Pack Contour Files**\\ Specify whether to include contour files in the packed directory. Consult the "Sample components" heading above for more information on this sample component. Contour files are included by default. If the "Contour files status" is "missing", this option is disabled and contour files will not be included in the packed sample.  
 +  * **Pack Metaphase Image Files**\\ Specify whether to include metaphase image files in the packed directory. Consult the "Sample components" heading above for more information on this sample component. Metaphase image files are included by default. If the "Metaphase images status" is "missing", this option is disabled and metaphase image files will not be included in the packed sample.
 +  * **Progress**\\ When the "Start packing" button is clicked, this progress bar will fill as components are copied to the specified directory. 
 </WRAP> </WRAP>
 <WRAP column half> <WRAP column half>
Line 14: Line 26:
 </WRAP> </WRAP>
 </WRAP> </WRAP>
 +
 +===== Move packed sample to destination =====
 +The packed sample directory must be moved to the destination computer. This can be accomplished simply by moving the directory using a USB stick or other transfer device. It may be desirable to compress (ie: zip) the packed sample before moving it. Note if a packed sample is compressed, ADCI cannot automatically uncompress it after it is moved to the destination computer, it must be uncompressed first before unpacking.
  
 ===== Unpack (import) sample ===== ===== Unpack (import) sample =====
Line 19: Line 34:
 <WRAP group> <WRAP group>
 <WRAP column half> <WRAP column half>
 +  * **Sample ID**\\ Cannot be modified. ID of sample to be unpacked.
 +  * **Description**\\ Description of the sample as specified when the sample was packed. The description can be modified at this time if desired. When the sample is unpacked, the description of the sample will consist of the content found in the description text box here.
 +  * **Contour files status / Metaphase images status**\\ If either of these sample components are not present in the packed sample, the status of the missing component is "missing", otherwise it is "found".
 +  * **Unpack Sample and Save As File**\\ Click "Specify File" to enter a file name for the unpacked "Saved sample file" component. This file will have the extension ".adcisample" (note: the ".adcisample" extension will be added automatically).
 +  * **Unpack Contour Files and Copy to ADCI Data Folder**\\ Specify whether to unpack the contour files component of the packed sample and copy them to the ADCI Data folder specified when ADCI was [[main:installation | installed]]. Consult the "Sample components" heading above for more information on this sample component. Contour files are unpacked and copied to the data folder by default. If contour files are not present in the packed sample, this checkbox is disabled. 
 +  * **Metaphase Image Files Dropdown**
 +    * **Unpack metaphase images and copy to specified folder**\\ Default selection. This option is disabled if metaphase images are not present in the packed sample. Click "Specify Folder" to choose a folder within which metaphase images found in the packed sample will be copied. Please note a new folder will not be created within the chosen folder, images will simply be copied to the chosen folder. This means it may be desirable to create a new folder to house the images before the sample is unpacked. 
 +    * **Use existing metaphase images in specified folder**\\ If metaphase images corresponding to the packed sample already exist on the destination computer, it is not necessary to copy the metaphase images within the packed sample to a destination folder. Use this option to specify the directory containing the preexisting metaphase images.
 +    * **Skip locating or unpacking metaphase images**\\ This option will ignore the metaphase images which may be part of the packed sample. Note if the option is selected, it will not be possible to view images in the [[main:metaphaseimgviewer | metaphase image viewer]].
 +  * **Progress**\\ When the "Start Unpacking" button is clicked, this progress bar will fill as components are unpacked. 
 </WRAP> </WRAP>
 <WRAP column half> <WRAP column half>
main/samplepackunpack.txt ยท Last modified: 2017/08/25 19:57 by yli