This shows you the differences between two versions of the page.
Both sides previous revision Previous revision Next revision | Previous revision Next revision Both sides next revision | ||
pipeline:utilities:sxpipe_moon_eliminator [2018/05/14 16:19] 127.0.0.1 external edit |
pipeline:utilities:sxpipe_moon_eliminator [2018/08/22 11:15] fmerino |
||
---|---|---|---|
Line 9: | Line 9: | ||
Usage in command line | Usage in command line | ||
- | sxpipe.py | + | sxpipe.py |
+ | |||
\\ | \\ | ||
===== Typical usage ===== | ===== Typical usage ===== | ||
Line 16: | Line 16: | ||
sxpipe moon_eliminator does not support MPI. | sxpipe moon_eliminator does not support MPI. | ||
- | Create reference 3D volume | + | There are two modes to run the program: |
+ | |||
+ | \\ | ||
+ | __1. Single Volume Mode:__ | ||
+ | |||
+ | Create reference 3D structure | ||
sxpipe.py moon_eliminator ' | sxpipe.py moon_eliminator ' | ||
- | Create reference 3D volume | + | Create reference 3D structure |
sxpipe.py moon_eliminator ' | sxpipe.py moon_eliminator ' | ||
- | Create reference 3D volume | + | Create reference 3D structure |
sxpipe.py moon_eliminator ' | sxpipe.py moon_eliminator ' | ||
+ | |||
+ | \\ | ||
+ | __2. Halfset Volumes Mode:__ | ||
+ | |||
+ | Create reference 3D structure and 3D mask from halfset unfiltered maps produced by MERIDIEN, using the expected molecular mass [kDa]. | ||
+ | |||
+ | sxpipe.py moon_eliminator ' | ||
Line 33: | Line 45: | ||
=== Main Parameters === | === Main Parameters === | ||
; input_volume_path : Input volume path: Path to input volume file containing the 3D density map. (default required string) | ; input_volume_path : Input volume path: Path to input volume file containing the 3D density map. (default required string) | ||
- | ; output_directory : Output directory: The results will be written here. This directory will be created automatically and it must not exist previously. (default required string) | + | |
+ | | ||
+ | ; %%--%%pixel_size : Output pixel size [A]: The original pixel size of dataset. This must be the pixel size after resampling when resample_ratio != 1.0. That is, it will be the pixel size of the output map. (default required float) | ||
; %%--%%mol_mass : Molecular mass [kDa]: The estimated molecular mass of the target particle in kilodalton. (default required float) | ; %%--%%mol_mass : Molecular mass [kDa]: The estimated molecular mass of the target particle in kilodalton. (default required float) | ||
- | ; %%--%%pixel_size : Output pixel size [A]: The original pixel size of dataset. This must be the pixel size after resampling when resample_ratio != 1.0. That is, it will be the pixel size of the output volume. (default required float) | ||
- | ; %%--%%moon_distance : Distance to the nearest moon [Pixels]: The moons further than this distance from the density surface will be elminated. The value smaller than the default is not recommended because it is difficult to avoid the stair-like gray level change at the edge of the density surface. (default 3) | ||
- | ; %%--%%falloff_speed : Falloff speed: Falloff speed of edge of the output 3D reference volume. The value corresponds to Gaussian sigma factor relative to the moon distance (i.e. gauss_sigma = moon_distance/ | ||
; %%--%%use_density_threshold : Use ad-hoc density threshold: Use user-provided ad-hoc density threshold, instead of computing the value from the molecular mass. Below this density value, the data is assumed not to belong to the main body of the particle density. (default none) | ; %%--%%use_density_threshold : Use ad-hoc density threshold: Use user-provided ad-hoc density threshold, instead of computing the value from the molecular mass. Below this density value, the data is assumed not to belong to the main body of the particle density. (default none) | ||
- | ; %%--%%resample_ratio : Resample ratio: Specify a value larger than 0.0. By default, the program does not resmaple | + | |
+ | ; %%--%%dilation : Dilation width [Pixels]: The pixel width to dilate the 3D binary map corresponding to the specified molecular mass or density threshold prior to softening the edge. By default, it is set to half of %%--%%moon_distance so that the voxels with 1.0 values in the mask are same as the hard-edged molecular-mass binary map. (default -1.0) | ||
+ | ; %%--%%edge_sigma : Edge sigma [Pixels]: The Gaussian sigma of transition area for soft-edge of the moon eliminator 3D mask. This value controls the falloff speed of soft-edge; The samller the sigma, the faster the falloff. Effective only with %%--%%edge_type=' | ||
+ | | ||
; %%--%%box_size : Output box size [Pixels]: The x, y, and z dimensions of cubic area to be windowed from input 3D volume for output 3D volumes. This must be the box size after resampling when resample_ratio != 1.0. (default none) | ; %%--%%box_size : Output box size [Pixels]: The x, y, and z dimensions of cubic area to be windowed from input 3D volume for output 3D volumes. This must be the box size after resampling when resample_ratio != 1.0. (default none) | ||
; %%--%%resampled_shift3d : Providing resampled 3D shifts: Use this option when you are providing the resampled 3D shifts (using pixel size of outputs) when %%--%%resample_ratio!=1.0. By default, the program assums the provided shifts are not resampled. (default False) | ; %%--%%resampled_shift3d : Providing resampled 3D shifts: Use this option when you are providing the resampled 3D shifts (using pixel size of outputs) when %%--%%resample_ratio!=1.0. By default, the program assums the provided shifts are not resampled. (default False) | ||
- | ; %%--%%shift3d_x : 3D x-shift [Pixels]: | + | ; %%--%%shift3d_x : 3D x-shift [Pixels]: 3D x-shift |
- | ; %%--%%shift3d_y : 3D y-shift [Pixels]: | + | ; %%--%%shift3d_y : 3D y-shift [Pixels]: 3D y-shift |
- | ; %%--%%shift3d_z : 3D z-shift [Pixels]: | + | ; %%--%%shift3d_z : 3D z-shift [Pixels]: 3D z-shift |
- | ; %%--%%invert_handedness : Invert handedness: Invert the handedness of the 3D volume. (default False) | + | ; %%--%%invert_handedness : Invert handedness: Invert the handedness of the 3D map. (default False) |
; %%--%%fl : Low-pass filter resolution [A]: >0.0: low-pass filter to the value in Angstrom; =-1.0: no low-pass filter. The program applies this low-pass filter before the moon elimination. (default -1.0) | ; %%--%%fl : Low-pass filter resolution [A]: >0.0: low-pass filter to the value in Angstrom; =-1.0: no low-pass filter. The program applies this low-pass filter before the moon elimination. (default -1.0) | ||
; %%--%%aa : Low-pass filter fall-off [1/Pixels]: Low-pass filter fall-off in absolute frequency. The program applies this low-pass filter before the moon elimination. Effective only when %%--%%fl > 0.0. (default 0.1) | ; %%--%%aa : Low-pass filter fall-off [1/Pixels]: Low-pass filter fall-off in absolute frequency. The program applies this low-pass filter before the moon elimination. Effective only when %%--%%fl > 0.0. (default 0.1) | ||
- | ; %%--%%generate_mask : Generate soft-edged mask: Generate | + | ; %%--%%generate_mask : Generate soft-edged mask: Generate soft-edged mask with specified method from the 3D binary |
\\ | \\ | ||
=== Advanced Parameters === | === Advanced Parameters === | ||
- | ; %%--%%gm_edge_width : Soft-edge width [Pixels]: The pixel width of transition area for soft-edged masking. Effective only with %%--%%generate_mask option. (default 6) | + | |
- | ; %%--%%gm_falloff_speed | + | |
+ | ; %%--%%gm_edge_sigma | ||
; %%--%%outputs_root : Root name of outputs: Specify the root name of all outputs. It cannot be empty string or only white spaces. (default vol3d) | ; %%--%%outputs_root : Root name of outputs: Specify the root name of all outputs. It cannot be empty string or only white spaces. (default vol3d) | ||
+ | ; %%--%%allow_disconnect : Allow disconnection: | ||
+ | ; %%--%%edge_type : Soft-edge type: The type of soft-edge for moon-eliminator 3D mask and a moon-eliminated soft-edged 3D mask. Available methods are (1) ' | ||
; %%--%%debug : Run with debug mode: Mainly for developer. (default False) | ; %%--%%debug : Run with debug mode: Mainly for developer. (default False) | ||
Line 62: | Line 79: | ||
=== List of output Files === | === List of output Files === | ||
|| **File Name** || **Discription** || | || **File Name** || **Discription** || | ||
+ | || *_ref_before_moon_elimination.hdf || File containing the 3D reference map before moon elimination (i.e., the 3D map just before applying moon elimination.). || | ||
|| *_ref_moon_eliminated.hdf || File containing the moon eliminated 3D reference. || | || *_ref_moon_eliminated.hdf || File containing the moon eliminated 3D reference. || | ||
|| *_mask_moon_elminator.hdf || File containing the moon elminator 3D mask. || | || *_mask_moon_elminator.hdf || File containing the moon elminator 3D mask. || | ||
Line 71: | Line 89: | ||
This command executes the following processes: | This command executes the following processes: | ||
- Extract resample ratio from ISAC run directory if necessary (mainly for R-VIPER models). | - Extract resample ratio from ISAC run directory if necessary (mainly for R-VIPER models). | ||
- | - Resample and window the volume | + | - Resample and window the map if necessary (mainly for R-VIPER models) |
- | - Shift 3D volume | + | - Shift 3D map if necessary. |
- Invert the handedness if necessary. | - Invert the handedness if necessary. | ||
- | - Apply low-pass filter to the input volume | + | - Apply low-pass filter to the input map before the moon elimination if necessary. |
- | - Create reference 3D volume | + | - Save reference 3D map before eliminating the moons. |
- | - Create 3D mask from the 3D bainary | + | - Create reference 3D map by eliminating the moons from the input map and save the results. |
+ | - Create 3D mask from the 3D binary | ||
\\ | \\ | ||
Line 86: | Line 105: | ||
\\ | \\ | ||
==== Developer Notes ==== | ==== Developer Notes ==== | ||
- | === 2018/04/12 Toshio Moriya === | + | === 2018/06/18 Toshio Moriya === |
- | Tips about balancing settings of moon_distance and falloff_speed | + | |
+ | Wish | ||
+ | * Add options for 3D rotation of the map. | ||
+ | |||
+ | === 2018/06/18 Toshio Moriya === | ||
+ | |||
+ | Tips about balancing settings of moon_distance, dilation, | ||
* moon_distance | * moon_distance | ||
- | * A shorter | + | * In principle, |
- | * If it is too long, the moons will be connected and creates strange low density shape at the edge of the monn distance. | + | * If moon_distance |
* On the other hand, if it is too short, soft-edge will have the stair-like gray level change because of quantization or digitization. | * On the other hand, if it is too short, soft-edge will have the stair-like gray level change because of quantization or digitization. | ||
- | * falloff_speed | + | * dilation |
- | * The falloff speed seems to have be smaller | + | * Setting dilation |
- | * If it is larger (or faster), the density distribution of moon eliminator 3D mask won't be smooth (spiky) because of quantization or digitization. | + | * Setting dilation to smaller |
- | * In addition, moon-eliminated reference 3D volume | + | * edge_sigma |
- | * Tested combinations with a density map at 1.12 [A/ | + | * In principle, smaller edge_sigma is better. |
- | * moon_distance=3 & falloff_speed=3.0 (gauss_sigma = 1.0[Pixels]) | + | * However, edge_sigma must be at least larger than 1[pixel]. |
- | * Very nice balance! | + | * If not, the density distribution of moon eliminator 3D mask won't be smooth (spiky) because of quantization or digitization. |
- | * moon_distance=3 & falloff_speed=5.0 (gauss_sigma = 0.6[Pixels]) | + | * In addition, moon-eliminated reference 3D map will have a strange dent near zero. |
- | * NG. The density distribution of moon eliminator 3D mask is not smooth. | + | |
- | * The moon-eliminated reference 3D volume has a strange dent near zero. | + | |
- | * That is, falloff_speed must be too fast for this moon_distance! | + | |
- | * moon_distance=6 & falloff_speed=3.0 (gauss_sigma = 2.0[Pixels]) | + | |
- | * OK but created strange low density shape at the edge of the monn distance. | + | |
- | * moon_distance=6 & falloff_speed=5.0 (gauss_sigma = 1.2[Pixels]) | + | |
- | * OK but created strange low density shape at the edge of the monn distance. | + | |
- | Tips about balancing settings of gm_edge_width and gm_falloff_speed | + | Tips about balancing settings of gm_dilation, |
+ | * gm_dilation | ||
+ | * Setting dilation to half of gm_edge_width generates mask where the voxels with 1.0 values are same as the hard-edged molecular-mass binary map (default behaviour). | ||
+ | * Setting dilation to smaller than half of gm_edge_width generates mask where the voxels with 1.0 values are smaller than the hard-edged molecular-mass binary map. | ||
* gm_edge_width | * gm_edge_width | ||
- | * A wider edge seems to be better. If it is too narrow, soft-edge will have the stair-like gray level change because of quantization or digitization. | + | * A wider gm_edge_width is better. If it is too narrow, soft-edge will have the stair-like gray level change because of quantization or digitization. |
- | * However, if it is too long, the soft-edge might touch the box boundary and create strange low density shape there. | + | * However, if it is too wide, the soft-edge might touch the box boundary and create strange low density shape there. |
- | * gm_falloff_speed | + | * gm_edge_sigma |
- | * The falloff speed seems to have be smaller | + | * In principle, |
- | * If it is larger, the density distribution of moon-eliminated | + | * However, gm_edge_sigma must be at least larger than 1[pixel]. |
+ | * If not, the density distribution of moon eliminator | ||
+ | * In addition, moon-eliminated reference 3D map will have a strange dent near zero. | ||
\\ | \\ | ||
Line 141: | Line 164: | ||
\\ | \\ | ||
- |