Function reference • x3ptools

All functions

df_to_x3p(): Convert a data frame into an x3p file

dim(<x3p>): Dimension of an x3p object

head(<x3p>): Show meta information of an x3p file

image(<x3p>): Raster image of an x3p surface

lea: Subsampled scan of a land-engraved area

print(<x3p>): Show meta information of an x3p file

stl_to_x3p(): Convert an STL file to an x3p file

tmd_to_x3p(): Read (or convert) from TMD file to x3p

wire: Subsampled wire cut scan

x3p_add_annotation(): Add annotations to an x3p object

x3p_add_grid(): Add a grid of helper lines to the mask of an x3p object

x3p_add_hline(): Add horizontal line to the mask of an x3p object

x3p_add_legend(): Display legend in active rgl object

x3p_add_mask(): Add/Exchange a mask for an x3p object

x3p_add_mask_layer(): Add a layer to the mask

x3p_add_meta() addtemplate_x3p(): Add/change xml meta information in x3p object

x3p_add_vline(): Add vertical line to the mask of an x3p object

x3p_average(): Average an x3p object

x3p_bin_stripes(): Add colored stripes of the surface gradient to the mask of an x3p object

x3p_circle_select(): Select a circle area on the surface of an x3p file using rgl

x3p_crop(): Crop an x3p object to a specified width and height

x3p_darker(): Darken active rgl object

x3p_delete_mask(): Delete mask from an x3p object

x3p_extract(): Extract values from a surface matrix based on a mask

x3p_extract_profile(): Interactively select a line on the active rgl device

x3p_extract_profile_segments(): Extract profiles from surface using multiple segments

x3p_flip_x() x_flip_x3p(): Flip the x coordinate of an x3p file

x3p_flip_y() y_flip_x3p(): Flip the y coordinate of an x3p image

x3p_fuzzyselect(): Interactive selection of region of interest

x3p_get_scale(): Check resolution of a scan

x3p_image() image_x3p(): Plot x3p object as an image

x3p_interpolate() interpolate_x3p(): Interpolate from an x3p object

x3p_lighter(): Lighten active rgl object

x3p_m_to_mum(): Convert x3p header information to microns from meters

x3p_mask_legend(): Get legend for mask colors

x3p_mask_quantile(): Draw a quantile region on the mask

x3p_modify_xml(): Modify xml elements meta information in x3p object

x3p_read() read_x3p(): Read an x3p file into an x3p object

x3p_read_dat(): Read data from an x-y-z file

x3p_read_folder(): Read all x3p files in a folder

x3p_read_plux(): Read information from plux file

x3p_rotate() rotate_x3p(): Rotate an x3p object

x3p_sample() sample_x3p(): Sample from an x3p object

x3p_scale_unit(): Scale x3p object by given unit

x3p_select(): Draw rectangle on the mask of an x3p file using rgl

x3p_shade_mask(): Shade the mask of an x3p object to reflect its surface profile

x3p_show_xml(): Show xml elements from meta information in x3p object

x3p_snapshot(): Take a snapshot of the active rgl device and save in a file

x3p_to_df(): Convert an x3p file into a data frame

x3p_transpose() transpose_x3p(): Transpose an x3p object

x3p_trim_na(): Trim rows and columns with missing values only from an x3p

x3p_write() write_x3p(): Write an x3p object to a file