squarenet.artist

Functions

atmost3D(g[, projection])
default_config()
kill_long_edges(x[, threshold])
sqplot(grid, verbose[, style, animate, ...])	Render a structured grid as either a static figure or a morphing animation.
validate(g)

class squarenet.artist.Path(*args, **kwargs)

Bases: PurePath

PurePath subclass that can make system calls.

Path represents a filesystem path but unlike PurePath, also offers methods to do system calls on path objects. Depending on your system, instantiating a Path will return either a PosixPath or a WindowsPath object. You can also instantiate a PosixPath or WindowsPath directly, but cannot instantiate a WindowsPath on a POSIX system or vice versa.

absolute()

Return an absolute version of this path by prepending the current working directory. No normalization or symlink resolution is performed.

Use resolve() to get the canonical path to a file.

chmod(mode, *, follow_symlinks=True)

Change the permissions of the path, like os.chmod().

classmethod cwd()

Return a new path pointing to the current working directory.

exists(*, follow_symlinks=True)

Whether this path exists.

This method normally follows symlinks; to check whether a symlink exists, add the argument follow_symlinks=False.

expanduser()

Return a new path with expanded ~ and ~user constructs (as returned by os.path.expanduser)

glob(pattern, *, case_sensitive=None)

Iterate over this subtree and yield all existing files (of any kind, including directories) matching the given relative pattern.

group()

Return the group name of the file gid.

hardlink_to(target)

Make this path a hard link pointing to the same file as target.

Note the order of arguments (self, target) is the reverse of os.link’s.

classmethod home()

Return a new path pointing to the user’s home directory (as returned by os.path.expanduser(‘~’)).

is_block_device()

Whether this path is a block device.

is_char_device()

Whether this path is a character device.

is_dir()

Whether this path is a directory.

is_fifo()

Whether this path is a FIFO.

is_file()

Whether this path is a regular file (also True for symlinks pointing to regular files).

is_junction()

Whether this path is a junction.

is_mount()

Check if this path is a mount point

is_socket()

Whether this path is a socket.

is_symlink()

Whether this path is a symbolic link.

iterdir()

Yield path objects of the directory contents.

The children are yielded in arbitrary order, and the special entries ‘.’ and ‘..’ are not included.

lchmod(mode)

Like chmod(), except if the path points to a symlink, the symlink’s permissions are changed, rather than its target’s.

lstat()

Like stat(), except if the path points to a symlink, the symlink’s status information is returned, rather than its target’s.

mkdir(mode=511, parents=False, exist_ok=False)

Create a new directory at this given path.

open(mode='r', buffering=-1, encoding=None, errors=None, newline=None)

Open the file pointed to by this path and return a file object, as the built-in open() function does.

owner()

Return the login name of the file owner.

read_bytes()

Open the file in bytes mode, read it, and close the file.

read_text(encoding=None, errors=None)

Open the file in text mode, read it, and close the file.

readlink()

Return the path to which the symbolic link points.

rename(target)

Rename this path to the target path.

The target path may be absolute or relative. Relative paths are interpreted relative to the current working directory, not the directory of the Path object.

Returns the new Path instance pointing to the target path.

replace(target)

Rename this path to the target path, overwriting if that path exists.

The target path may be absolute or relative. Relative paths are interpreted relative to the current working directory, not the directory of the Path object.

Returns the new Path instance pointing to the target path.

resolve(strict=False)

Make the path absolute, resolving all symlinks on the way and also normalizing it.

rglob(pattern, *, case_sensitive=None)

Recursively yield all existing files (of any kind, including directories) matching the given relative pattern, anywhere in this subtree.

rmdir()

Remove this directory. The directory must be empty.

samefile(other_path)

Return whether other_path is the same or not as this file (as returned by os.path.samefile()).

stat(*, follow_symlinks=True)

Return the result of the stat() system call on this path, like os.stat() does.

symlink_to(target, target_is_directory=False)

Make this path a symlink pointing to the target path. Note the order of arguments (link, target) is the reverse of os.symlink.

touch(mode=438, exist_ok=True)

Create this file with the given access mode, if it doesn’t exist.

unlink(missing_ok=False)

Remove this file or link. If the path is a directory, use rmdir() instead.

walk(top_down=True, on_error=None, follow_symlinks=False)

Walk the directory tree from this directory, similar to os.walk().

write_bytes(data)

Open the file in bytes mode, write to it, and close the file.

write_text(data, encoding=None, errors=None, newline=None)

Open the file in text mode, write to it, and close the file.

squarenet.artist.atmost3D(g, projection=(0, 1, 2))

squarenet.artist.default_config()

I. MAIN ARGUMENTS — passed directly to sqplot()

stylerendering style. One of:

‘checkerboard’ — points coloured in a 2-colour tile pattern ‘mesh’ — grid lines drawn at 4 levels of density, ‘scatter’ — plain point cloud; depth-coloured (cmap) in

3-D, black in 2-D.

animateFalse → single static PNG.

True → GIF that morphs continuously from the input grid

to the identity grid and back.

save : whether to write the output to disk. save_path : destination path.

II. EXTRA ARGUMENTS — passed as cfg = {…}

All keys are optional. Only specify what you want to override; everything else is filled from the defaults shown here.

Layout

figsize : (width, heigth) size of the base figure

Projection

projection3-tuple of axis indices, e.g. (0, 1, 2).

Used if ndim >= 3. this selects both which axes to keep AND in what order

Scale & density

scale_factor : positive integer. bigger -> finer details pointsize : base size for a single point linewidth : base width for a mesh lines. mesh_long_edge : length ratio (relative to the median) above wich an edge will not be ploted in ‘mesh’ style

Colours

colors_checkerboard : 2 colors for the ‘checkerboard’ style. cmap_scatter : colormap e.g. ‘plasma’, ‘coolwarm’ used in ‘scatter’ to encode the depth.

Animation

frames : number of frames in the animation interval : inter-frame delay in milliseconds (for interactive sessions). fps : frames per second written (for the saved GIF).

Display

showif True, calls plt.show().

Will fail if session is not interactive

squarenet.artist.kill_long_edges(x, threshold=1)

squarenet.artist.project(gridpoints, feature_axes=(0, 1), index=0)

squarenet.artist.sqplot(grid, verbose, style='checkerboard', animate=False, save=True, save_path='sqrnet/plot', cfg=None)

Render a structured grid as either a static figure or a morphing animation.

The input grid is displayed using one of several rendering styles and may optionally be animated by continuously interpolating between the input grid and the corresponding identity grid.

Parameters:

• grid (ndarray) – Structured grid of shape (..., D), where D is either 2 or 3.

• verbose (bool) – If True, prints progress information while rendering or exporting.

• style ({"checkerboard", "mesh", "scatter"}, default="checkerboard") –

  Rendering style.

  • "checkerboard": alternating colours on adjacent grid cells.

  • "mesh": draw the grid connectivity as a wireframe.

  • "scatter": draw only the grid points. In 3-D, points are coloured

  according to their depth after projection; in 2-D they are drawn in black.

• animate (bool, default=False) – If True, generate an animation interpolating between the input grid and the identity grid. Otherwise, produce a single static figure.

• save (bool, default=True) – If True, save the generated figure or animation to disk.

• save_path (str, default="sqrnet/plot") – Output path used when save=True.

• cfg (dict, optional) – Rendering configuration. Any omitted entries are filled with the default values returned by default_config(). See help(default_config) for the complete list of supported options.

Returns:

• fig (matplotlib.figure.Figure) – The generated figure.

• ani (matplotlib.animation.FuncAnimation or None) – The animation object if animate=True; otherwise None.

See also

default_config

Default rendering options and their documentation.

squarenet.artist.validate(g)