xhorizon.shell_junction.reg_corner_masks module

This module provides functions for applying uvbounds masks to correct blocks in a given region. These functions should directly edit and return the input region object.

xhorizon.shell_junction.reg_corner_masks.EFreg(reg, abcd=None, u0=None, v0=None)

xhorizon.shell_junction.reg_corner_masks.EFreg2a(reg, abcd=None, u0=None, v0=None)

For Hayward-like regions (aka N=2 and f(0)>0). Assumes slice in outermost block.

reg = The region to mask. abcd = Which corner junction label is this piece, with standard label scheme.

Should be a single letter string ‘a’ ‘b’ ‘c’ or ‘d’.

u0, v0 = Location to slice.

Returns the same region that was input, after editing.

Region is masked by removing unwanted blocks and setting uvbounds on remaining blocks.

Block order is [inner, middle, outer] (this is arbitrary, just happens to be how EFreg2a is generated). Setting any of the uvbounds to np.nan causes all inequalities to fail, which causes an error unless block is removed.

xhorizon.shell_junction.reg_corner_masks.EFreg1a(reg, abcd=None, u0=None, v0=None)

For Schwarzschild-like regions (aka N=1 and f(0)<0). Assumes slice in outermost block.

reg = The region to mask. abcd = Which corner junction label is this piece, with standard label scheme.

Should be a single letter string ‘a’ ‘b’ ‘c’ or ‘d’.

u0, v0 = Location to slice.

Returns the same region that was input, after editing.

Region is masked by removing unwanted blocks and setting uvbounds on remaining blocks.

Block order is [inner, outer] (this is arbitrary, just happens to be how EFreg1a is generated). Setting any of the uvbounds to np.nan causes all inequalities to fail, which causes an error unless block is removed.

xhorizon.shell_junction.reg_corner_masks.MAXreg2a(reg, abcd=None, u0=None, v0=None)

For Schwarzschild-like regions (aka N=2 and f(0)>0).

reg = The region to mask. abcd = Which corner junction label is this piece, with standard label scheme.

Should be a single letter string ‘a’ ‘b’ ‘c’ or ‘d’.

u0, v0 = Location to slice.

Returns the same region that was input, after editing.

Region is masked by removing unwanted blocks and setting uvbounds on remaining blocks.

Block order is [top, right, bottom, left] (this is arbitrary, just happens to be how MAXreg2a is generated). Setting any of the uvbounds to np.nan causes all inequalities to fail, which causes an error unless block is removed.