Skip to content

Commit

Permalink
documentation update and version update
Browse files Browse the repository at this point in the history
  • Loading branch information
jewettaij committed Jul 20, 2021
1 parent cb531cf commit f0a6f4d
Show file tree
Hide file tree
Showing 2 changed files with 26 additions and 16 deletions.
2 changes: 1 addition & 1 deletion bin/filter_mrc/filter_mrc.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ using namespace std;


string g_program_name("filter_mrc");
string g_version_string("0.29.7");
string g_version_string("0.29.8");
string g_date_string("2021-7-19");


Expand Down
40 changes: 25 additions & 15 deletions doc/doc_filter_mrc.md
Original file line number Diff line number Diff line change
Expand Up @@ -1571,29 +1571,39 @@ Consequently they are not integers (unless the
["-w 1"](#Voxel-Width) argument was used).


### -max-voxels-to-feature *num_voxels*



### -max-distance-to-feature *distance*

*(This argument is optional.)*

The *num_voxels* parameter specifies how far a voxel can be from the surface
(or curve) you are detecting in order for it to be excluded from the
The *distance* parameter specifies how far a voxel can be from the surface
(or curve) that you are detecting in order for it to be excluded from the
file containing the coordinates of that surface (or curve).
For example, suppose you are using the "-membrane" or "-edge" arguments
together with the "-normals-file" argument.
Voxels that are further than *num_voxels* away from the surface will
*not* be included in the PLY file that is generated.
*(This parameter is measured in units of voxels, not physical distance.
By default this number is (√3)/2≈0.8660254.
Setting it to "inf" disables this feature.
The remaining voxels will have their coordinates projected onto the surface
(or curve), regardless of how far away they are.)*
to detect a surface, as well as the "-normals-file" argument
to save that surface to a PLY file.
Voxels that are further than *distance* away from the detected
surface will *not* be included in the PLY file that is generated.
(The *distance* parameter has units of physical distance, *not* voxels.
By default, it is equal to 1.5 times the *thickness* parameter
used with the "-membrane", "-edge", or "-curve" arguments.
Setting it to "inf" disables this feature.)

*Note that voxels which are not excluded will have their coordinates
projected onto the surface (or curve), regardless of how far away
they are from it.*


### -max-voxels-to-feature *num_voxels*

*(This argument is optional.)*

### -max-distance-to-feature *distance*
This argument is identical to
[-max-voxels-to-feature](#-max-voxels-to-feature-num_voxels),
except that the distance is expressed in units of physical distance
(not voxels).
[-max-distance-to-feature](#-max-distance-to-feature-num_voxels),
except that the distance is expressed in units of voxels
(not physical distance).


### -connect-angle theta
Expand Down

0 comments on commit f0a6f4d

Please sign in to comment.