]> Creatis software - clitk.git/blob - scripts/create_midP_masks-2.0.sh
motion masks with and without bands
[clitk.git] / scripts / create_midP_masks-2.0.sh
1 #! /bin/bash 
2   
3 ###############################################################################
4 #
5 # FILE: create_midP-2.0.sh
6 # AUTHOR: RĂ´mulo Pinho 05/08/2011
7 #
8 # Version 2.0 of the create_midP_masks.sh script. The most relevant changes are:
9 #   * creation of bands around input and output image regions to try to improve 
10 #   the registration along lung boundaries (naturally, it depends on the quality
11 #   of motion mask generation).
12 #   * some steps are now in different modules, to facilitate re-use (see "includes" section).
13 #   * minor modifications on output file names.
14 #   * attempt to simplify the code a bit.
15 #
16 ###############################################################################
17
18 source `dirname $0`/midp_common.sh
19
20 extract_patient()
21 {
22   echo "$phase_file -> Extracting patient..."
23   clitkExtractPatient -i $phase_file -o $mask_dir_tmp/patient_mask_$phase_nb.mhd --noAutoCrop -a $afdb_file $ExtractPatientExtra
24 #   abort_on_error clitkExtractPatient $?
25
26   clitkSetBackground -i $phase_file -o $mask_dir_tmp/patient_$phase_nb.mhd --mask $mask_dir_tmp/patient_mask_$phase_nb.mhd --outsideValue -1000
27 #   abort_on_error clitkSetBackground $?
28 }
29
30 extract_bones()
31 {
32   if [ x = x$ExtractBonesLower1 ]; then
33     ExtractBonesLower1=120
34   fi
35   if [ x = x$ExtractBonesLower2 ]; then
36     ExtractBonesLower2=80
37   fi
38   echo "$phase_file -> Extracting bones..."
39   clitkImageConvert -i $phase_file -o $mask_dir_tmp/float_$phase_nb.mhd -t float
40   clitkExtractBones -i $mask_dir_tmp/float_$phase_nb.mhd -o $mask_dir_tmp/bones_$phase_nb.mhd -a $afdb_file --lower1 $ExtractBonesLower1 --upper1 2000 --lower2 $ExtractBonesLower2 --upper2 2000 --smooth --time 0.0625 --noAutoCrop
41 }
42
43 extract_lungs()
44 {
45   echo "$phase_file -> Extracting lungs..."  
46   clitkExtractLung -i $phase_file -o $mask_dir_tmp/lungs_$phase_nb.mhd -a $afdb_file --noAutoCrop --doNotSeparateLungs --type 1
47 }
48
49
50
51 resample()
52 {
53   echo "$phase_file -> Resampling..."
54   clitkResampleImage -i $mask_dir_tmp/patient_$phase_nb.mhd -o $mask_dir_tmp/patient_$phase_nb.mhd --spacing $resample_spacing --interp $resample_algo
55   clitkResampleImage -i $mask_dir_tmp/patient_mask_$phase_nb.mhd -o $mask_dir_tmp/patient_mask_$phase_nb.mhd --spacing $resample_spacing --interp $resample_algo
56   clitkResampleImage -i $mask_dir_tmp/lungs_$phase_nb.mhd -o $mask_dir_tmp/lungs_$phase_nb.mhd --like $mask_dir_tmp/patient_$phase_nb.mhd
57 }
58
59 compute_motion_mask()
60 {
61   if [ x = x$MotionMaskOffsetDetect ]; then
62     MotionMaskOffsetDetect="0,-5,0"
63   fi
64   if [ x = x$FillingLevel ]; then
65     FillingLevel=94
66   fi
67
68   clitkMotionMask -i $mask_dir_tmp/patient_$phase_nb.mhd -o $mask_dir_tmp/mm_$phase_nb.mhd --featureLungs $mask_dir_tmp/lungs_$phase_nb.mhd --upperThresholdLungs -400 --fillingLevel $FillingLevel --offsetDetect $MotionMaskOffsetDetect --pad --writeFeature=$mask_dir_tmp/feature_$phase_nb.mhd $MotionMaskExtra 
69   #--monitor=$mask_dir_tmp/monitor_$phase_nb.mhd
70 }
71
72 create_banded_mask()
73 {
74   input=$1
75   input_mask=$2
76   output=$3
77   output_mask=$4
78   radius=$5
79
80   input_dir=`dirname $input`
81   input_base=`basename $input`
82
83   # first band
84   clitkMorphoMath -i $input_mask -o $input_dir/extra1_$input_base --type 1 --radius $radius
85   clitkImageArithm -i $input_dir/extra1_$input_base -j $input_mask -o $input_dir/band1_$input_base -t 7
86   clitkBinarizeImage -i $input_dir/band1_$input_base -o $input_dir/band1_$input_base -l 1 -u 1 --fg 100 --mode both
87   clitkImageConvert -i $input_dir/band1_$input_base -o $input_dir/short_band1_$input_base -t short
88   
89   # second band
90   clitkMorphoMath -i $input_dir/extra1_$input_base -o $input_dir/extra2_$input_base --type 1 --radius $radius
91   clitkImageArithm -i $input_dir/extra2_$input_base -j $input_dir/extra1_$input_base -o $input_dir/band2_$input_base -t 7
92   clitkBinarizeImage -i $input_dir/band2_$input_base -o $input_dir/band2_$input_base -l 1 -u 1 --fg 200 --mode both
93   clitkImageConvert -i $input_dir/band2_$input_base -o $input_dir/short_band2_$input_base -t short
94   
95   # combine bands with masks
96   clitkImageArithm -i $input_mask -j $input_dir/band1_$input_base -o $output_mask -t 0
97   clitkImageArithm -i $output_mask -j $input_dir/band2_$input_base -o $output_mask -t 0
98   # combine bands with image
99   clitkCombineImage -i $input_dir/short_band1_$input_base -j $input -m $input_dir/band1_$input_base -o $output
100   clitkCombineImage -i $input_dir/short_band2_$input_base -j $output -m $input_dir/band2_$input_base -o $output
101
102   # clean-up
103   rm `echo $input_dir/extra?_$input_base | sed 's:.mhd:.*:g'`
104   rm `echo $input_dir/band?_$input_base | sed 's:.mhd:.*:g'`
105   rm `echo $input_dir/short_band?_$input_base | sed 's:.mhd:.*:g'`
106 }
107
108 create_registration_masks()
109 {
110   # extract inside and outside lung regions from the patient image, 
111   # using the motion mask computed previously
112   echo "$phase_file -> Setting Background..."
113   clitkSetBackground -i $mask_dir_tmp/patient_$phase_nb.mhd -o $mask_dir_tmp/inside_$phase_nb.mhd --mask $mask_dir_tmp/mm_$phase_nb.mhd --outsideValue -1200
114   clitkSetBackground -i $mask_dir_tmp/patient_$phase_nb.mhd -o $mask_dir_tmp/outside_$phase_nb.mhd --mask $mask_dir_tmp/mm_$phase_nb.mhd --outsideValue -1200 --fg
115
116   # the registration masks for inside (and outside) region correspond
117   # to the motion mask (and its complement) plus extra grey value bands,
118   # obtained with morphological dilations.
119   # 
120   echo "$phase_file -> Creating registration masks..."
121   # inside
122   clitkMorphoMath -i $mask_dir_tmp/mm_$phase_nb.mhd -o $mask_dir_tmp/mask_inside_$phase_nb.mhd --type 1 --radius 8
123   create_banded_mask $mask_dir_tmp/inside_$phase_nb.mhd $mask_dir_tmp/mm_$phase_nb.mhd $mask_dir_tmp/banded_inside_$phase_nb.mhd $mask_dir_tmp/banded_mask_inside_$phase_nb.mhd 4
124   # outside 
125   clitkExtractPatient -i $mask_dir_tmp/outside_$phase_nb.mhd -o $mask_dir_tmp/mm_outside_$phase_nb.mhd --noAutoCrop
126   clitkMorphoMath -i $mask_dir_tmp/mm_outside_$phase_nb.mhd -o $mask_dir_tmp/mask_outside_$phase_nb.mhd --type 1 --radius 8
127   create_banded_mask $mask_dir_tmp/outside_$phase_nb.mhd $mask_dir_tmp/mm_outside_$phase_nb.mhd $mask_dir_tmp/banded_outside_$phase_nb.mhd $mask_dir_tmp/banded_mask_outside_$phase_nb.mhd 4
128 }
129
130 mm_preprocessing()
131 {
132   extract_patient
133   # extract_bones
134   extract_lungs
135   # remove_tmp_masks 1
136   if [ $resample_spacing -ne 0 ] ; then 
137     resample
138   fi
139 }
140
141 mm_postprocessing()
142 {
143   # remove_tmp_masks 2
144   # remove_tmp_masks 3
145   create_registration_masks
146 }
147
148 motion_mask()
149 {
150   #set cmd line variables
151   mhd4d=`basename $1`
152   if [ $# -eq 3 ] ; then
153     resample_spacing=$2
154     resample_algo=$3
155   else
156     resample_spacing=0
157     resample_algo=0
158   fi
159
160   dir=`dirname $1`
161   cd $dir
162     
163   # import variables specific to each patient
164   if test -e ./variables; then
165     source ./variables
166   fi
167
168   #set other global variables
169   if [ $resample_spacing -ne 0 ] ; then
170     mask_dir="MASK-${resample_spacing}mm-$resample_algo"
171   else
172     mask_dir="MASK"
173   fi
174   mask_dir_tmp="tmp.$mask_dir"
175   extract_4d_phases $mhd4d
176
177   echo
178   echo "------------ Motion mask from create_midP_masks.sh ------------"
179   start=`date`
180   echo "start: $start"
181   echo
182
183   # the motion masks are first created in a tmp directory. this directory is 
184   # later going to be renamed to the final motion mask directory. concurrent
185   # executions trying to create the same set of masks will be blocked until
186   # the first execution finishes. naturally, these other executions will not
187   # recreate the masks. so first we try to create the tmp directory. 
188   # if the creation fails, it means that another execution is
189   # already creating the masks, so this execution will be blocked. the
190   # execution is unblocked only when the creation of masks is finished and
191   # the mask directory is renamed.
192   #
193   # ATTENTION: RP - 08/02/2011
194   # robustness issue: tmp directory may exist but may be empty or 
195   # incomplete. the solution is to check per file, but I'll leave it like 
196   # this for the moment.
197   do_mm=0
198   if [ $(ls -d $mask_dir 2> /dev/null | wc -l) -eq 0 ]; then
199     mkdir $mask_dir_tmp 2> /dev/null
200     return_mkdir=$?
201     if [ $return_mkdir == 0 ]; then
202       do_mm=1 
203     else
204       while [[ $(ls -d $mask_dir 2> /dev/null | wc -l) -eq 0 ]]; do
205         echo "waiting creation of motion masks..."
206         sleep 2
207       done
208       echo "finished waiting"
209     fi  
210   fi
211   
212 #   do_mm=1
213 #   mask_dir_tmp=$mask_dir
214   if [ $do_mm == 1 ]; then
215     mask_log_dir=$mask_dir_tmp/LOG
216     mkdir -p $mask_log_dir
217
218     # multi-threaded pre-processing for motion mask calcs
219     pids=( )
220     for i in $( seq 0 $((${#phase_nbs[@]} - 1))); do
221       phase_nb=${phase_nbs[$i]}
222       phase_file=${phase_files[$i]}
223       afdb_file=`echo $phase_file | sed 's/mhd/afdb/'`
224
225       check_threads $MAX_THREADS
226       mm_preprocessing &
227       pids=( "${pids[@]}" "$!" )
228     done
229
230     wait_pids ${pids[@]}
231     for ret in $ret_codes; do
232       abort_on_error mm_preprocessing $ret clean_up_masks
233     done
234
235     # single-threaded motion mask calc
236     for i in $( seq 0 $((${#phase_nbs[@]} - 1))); do
237       phase_nb=${phase_nbs[$i]}
238       phase_file=${phase_files[$i]}
239
240       check_threads 1
241       echo "$phase_file -> Computing motion mask..."
242       compute_motion_mask > $mask_log_dir/motion_mask_$phase_file.log
243       abort_on_error compute_motion_mask $? clean_up_masks
244     done
245
246     # multi-threaded post-processing of motion mask calcs
247     pids=( )
248     for i in $( seq 0 $((${#phase_nbs[@]} - 1))); do
249       phase_nb=${phase_nbs[$i]}
250       phase_file=${phase_files[$i]}
251
252       check_threads $MAX_THREADS 
253       mm_postprocessing &
254       pids=( "${pids[@]}" "$!" )
255     done
256   
257     wait_pids ${pids[@]}
258     for ret in $ret_codes; do
259       abort_on_error mm_postprocessing $ret clean_up_masks
260     done
261
262
263     # rename tmp mask directory after mask creation
264     check_threads 1
265     mv -f $mask_dir_tmp $mask_dir
266   fi
267
268   echo
269   echo "-------- Motion mask done ! ---------"
270   end=`date`
271   echo "start: $start"
272   echo "end: $end"
273   echo
274 }
275
276
277 #################
278 # main  #
279 #################
280
281 if [ $# -ne 3 -a $# -ne 1 ]; then
282   echo "Usage: $0 CT_4D [RESAMPLE_SPACING RESAMPLE_ALGORITHM]"
283   exit -1
284 fi
285
286 #
287 # variables exported in this scope
288 #
289 # mask_dir: directory where all masks are kept
290 #
291
292 if [ $1 != "using-as-lib" ]; then
293   if [ $# -eq 3 ] ; then
294     motion_mask $1 $2 $3
295   else
296     motion_mask $1
297   fi
298 fi