MPOLE Programs

Version 2.4

Functional listing
Level 1 listing
Level 2 listing

Functional List

Name Calling sequence Keywords
I/O
cm2csv cm2csv, pls, cm minflux=minflux; file=file;
cm_list cm_list, cm, [ pls ] ntop=ntop; err=err; format=format;
dm2tex dm2tex, pls, dm vstring = vstring;
dm_print dm_print, pls, dm vstring = vstring; col_space=cs;
latex_poles latex_poles, pls view = view; tan_plane; pwr = pwr; tot;
rd_pns rd_pns, file_name, pls [ , nulls [ , sepr ] ] view = view; dm = dm; multi; norefine; info; norelabel; noends; rmax = rmax;
write_pns write_pls, file_name, pls [ , nls [ , sepr ] ] view = view; append; dm=dm;
Calculations
all_nulls nls = all_nulls( pls ) noasymp;
all_seprs sprs = all_seprs( pls, nulls ) ref_max; no_info;
cribbon cr = cribbon( pls, fl ) or cr = cribbon( pls, nls, spr ) -
connectivity cm = connectivity( pls ) nlines=nlines; phicut=phicut; nopos; noneg; doonly = name_list; err = err; max_steps = max_steps;
current_solve i = current_solve( psi0, si [, m ] ) sweep; init=i; erg=erg;
domain_matrix dm = domain_matrix( pls, nls, [ spr ] ) planar; leaf;
mut_induct_mat m = mut_induct_mat( pls, nls, sepr ) verbose;
xadd_nulls xadd_nulls, pls, nls z=z; view=view;
xselect_fl xselect_fl, pls z0 = [ zlist ]; view=view; quiet;
xselect_null new_nulls = xselect_nulls( nls [, pls ] ) gamma; over; omit; view=view;
Graphics
dm_schematic dm_schematic, pls, dm title=title; nosum; linestyles=linetsyles; min_deg=min_deg; nophi; format=format;
fill_dmn_fp fill_dmn_fp, pls, i1, i2, null1, null2 shrink=fctr; shade=shade; view=view;
pls_phi_hist pls_phi_plot, pls scl=scl; mx; phimax=phimax; nlab=nlab; nmax=nmax; title=title;
polka_map polka_map, pls over; nolab; view = view; maxrad = maxrad; flux_scl=flux_scl; axis=ax;
show_3dnulls show_3dnulls, nulls label;
show_3dpoles show_3dpoles, pls xrange = [ x0, x1 ]; yrange = [ y0, y1 ]; zrange = [ z0, z1 ]; over; nolab; zaxis = za; ax = ax; az = az;
show_connectivity show_connectivity, pls, c_mat min_flux = min_flux; count = count; inf;
show_cr_skel show_cr_skel, cr i = i ; norm_i = ni; view = view; threed; ribs=n;
show_dm show_dm, pls, dm linestyle = linestyle; mindegree = md; inf;
show_domain show_domain, pls, ia, ib ntries = ntries; nlines = nlines; threed; rad = rad; view = view; max_segs = max_segs;
show_flux_tube show_flux_tube, pls, x0 nlines=nlines; radius=radius; threed; view=view; circle; clip; dir;
show_fp show_fp, pls, nls view = view; nosepx; nogamma; view = view; threed; clip; max_segs; label; axis=ax; over; color; mg;
show_loop_skeleton show_loop_skeleton, fl, rad view = view; threed; skip=skip;
show_nulls show_nulls, nulls label; new; view = view;
show_poles show_poles, pls xrange = [ x0, x1 ]; yrange = [ y0, y1 ]; over; color; nolab; axis=ax; view = view; mg;
show_random_3dlines show_random_3dlines, pls nlines=nlines;
show_sepr show_sepr, pls, nls, spr view = view; threed; shadow; clip;
show_sepx show_sepx, pls, null view = view; thrnge = [ th0, th1]; thvals = thv; nlines = n; threed; clip;
sum_graph sum_graph, pls, nls, spr, [ dm ] title=title; noorphans; leaf;
voronoi_pls voronoi_pls, pls fill;
Analysis
dm_schematic dm_schematic, pls, dm title=title; nosum; linestyles=linetsyles; min_deg=min_deg; nophi; format=format;
domain_char res = domain_char( pls, ia, ib, add=add ) n = n; graph; threed; rad;
index_check index_check, pls, nls, [ spr ] -
line_info info = line_info( pls, fl ) -
null_graph null_graph, nls, spr title=title; nosum; noorphans;
pls_phi_hist pls_phi_plot, pls scl=scl; mx; phimax=phimax; nlab=nlab; nmax=nmax; title=title;
sepr_info info = sepr_info( pls, nulls, sepr ) structure; lineclose;
sum_graph sum_graph, pls, nls, spr, [ dm ] title=title; noorphans; leaf;
Viewing
disk2tan_plane view = disk2tan_plane( pls ) rad = rad; b = b; p = p; center_hel = ( lat, cmd ); center_disk = ( x0, y0 ); date; vert; mg = mg; must contain fields;
new_tan_plane new_tan_plane, pls, view, new_center [, options ] new_tan_plane, pls, view, match=view2 match = view2; hel; disk; tp;
solar_rotate_view new_view = solar_rotate_view( view, time ) to = date; rad=rad; b0=b0; shift=[dx,dy];
view2time time = view2time( view ) days; from=datestr;

Alphabetcal List: Level 1

Name Calling sequence Keywords
all_nulls nls = all_nulls( pls ) noasymp;
all_seprs sprs = all_seprs( pls, nulls ) ref_max; no_info;
cm2csv cm2csv, pls, cm minflux=minflux; file=file;
cm_list cm_list, cm, [ pls ] ntop=ntop; err=err; format=format;
connectivity cm = connectivity( pls ) nlines=nlines; phicut=phicut; nopos; noneg; doonly = name_list; err = err; max_steps = max_steps;
cribbon cr = cribbon( pls, fl ) or cr = cribbon( pls, nls, spr ) -
current_solve i = current_solve( psi0, si [, m ] ) sweep; init=i; erg=erg;
disk2tan_plane view = disk2tan_plane( pls ) rad = rad; b = b; p = p; center_hel = ( lat, cmd ); center_disk = ( x0, y0 ); date; vert; mg = mg; must contain fields;
dm2tex dm2tex, pls, dm vstring = vstring;
dm_print dm_print, pls, dm vstring = vstring; col_space=cs;
dm_schematic dm_schematic, pls, dm title=title; nosum; linestyles=linetsyles; min_deg=min_deg; nophi; format=format;
domain_char res = domain_char( pls, ia, ib, add=add ) n = n; graph; threed; rad;
domain_matrix dm = domain_matrix( pls, nls, [ spr ] ) planar; leaf;
fill_dmn_fp fill_dmn_fp, pls, i1, i2, null1, null2 shrink=fctr; shade=shade; view=view;
index_check index_check, pls, nls, [ spr ] -
inv_lam_func u = inv_lam_func( lambda ) -
latex_poles latex_poles, pls view = view; tan_plane; pwr = pwr; tot;
line_info info = line_info( pls, fl ) -
mut_induct_mat m = mut_induct_mat( pls, nls, sepr ) verbose;
new_tan_plane new_tan_plane, pls, view, new_center [, options ] new_tan_plane, pls, view, match=view2 match = view2; hel; disk; tp;
null_graph null_graph, nls, spr title=title; nosum; noorphans;
pixel2tan_plane view = pixel2tan_plane( pls, lat, cmd ) rad = rad; b = b; p = p; ref_pixel; pix_scale;
pls_phi_hist pls_phi_plot, pls scl=scl; mx; phimax=phimax; nlab=nlab; nmax=nmax; title=title;
polka_map polka_map, pls over; nolab; view = view; maxrad = maxrad; flux_scl=flux_scl; axis=ax;
rd_pns rd_pns, file_name, pls [ , nulls [ , sepr ] ] view = view; dm = dm; multi; norefine; info; norelabel; noends; rmax = rmax;
sepr_info info = sepr_info( pls, nulls, sepr ) structure; lineclose;
show_3dnulls show_3dnulls, nulls label;
show_3dpoles show_3dpoles, pls xrange = [ x0, x1 ]; yrange = [ y0, y1 ]; zrange = [ z0, z1 ]; over; nolab; zaxis = za; ax = ax; az = az;
show_connectivity show_connectivity, pls, c_mat min_flux = min_flux; count = count; inf;
show_cr_skel show_cr_skel, cr i = i ; norm_i = ni; view = view; threed; ribs=n;
show_dm show_dm, pls, dm linestyle = linestyle; mindegree = md; inf;
show_domain show_domain, pls, ia, ib ntries = ntries; nlines = nlines; threed; rad = rad; view = view; max_segs = max_segs;
show_flux_tube show_flux_tube, pls, x0 nlines=nlines; radius=radius; threed; view=view; circle; clip; dir;
show_fp show_fp, pls, nls view = view; nosepx; nogamma; view = view; threed; clip; max_segs; label; axis=ax; over; color; mg;
show_gamma_lines show_gamma_lines, pls, nulls
show_loop_skeleton show_loop_skeleton, fl, rad view = view; threed; skip=skip;
show_nulls show_nulls, nulls label; new; view = view;
show_poles show_poles, pls xrange = [ x0, x1 ]; yrange = [ y0, y1 ]; over; color; nolab; axis=ax; view = view; mg;
show_random_3dlines show_random_3dlines, pls nlines=nlines;
show_sepr show_sepr, pls, nls, spr view = view; threed; shadow; clip;
show_sepx show_sepx, pls, null view = view; thrnge = [ th0, th1]; thvals = thv; nlines = n; threed; clip;
solar_rotate_view new_view = solar_rotate_view( view, time ) to = date; rad=rad; b0=b0; shift=[dx,dy];
sum_graph sum_graph, pls, nls, spr, [ dm ] title=title; noorphans; leaf;
tan_plane2disk new_view = tan_plane2disk( pls, view ) -
view_xform view = view_xform( lat, cmd ) rad = rad; b = b; p = p;
voronoi_pls voronoi_pls, pls fill;
write_pns write_pls, file_name, pls [ , nls [ , sepr ] ] view = view; append; dm=dm;
xadd_nulls xadd_nulls, pls, nls z=z; view=view;
xselect_fl xselect_fl, pls z0 = [ zlist ]; view=view; quiet;
xselect_null new_nulls = xselect_nulls( nls [, pls ] ) gamma; over; omit; view=view;

Alphabetcal List: Level 2

Name Calling sequence Keywords
advance_dif_rot advance_diff_rot, lc, time -
asym_fl_map r2 = asym_fl_map( pls, r1, closes=closes )
avg_bp ab = avg_bp( pls, fl ) -
calc_sepr_info calc_sepr_info, pls, nulls, sepr -
clip_fl fl = clip_fl( fl ) -
closest_pole i = closest_pole( pls, x ) -
create_null null = create_null( pls, x ) KEYWORD: noend - if set the spines will not be traced -
create_pls pls = create_pls( np ) -
create_spr spr = create_spr( [ array ] ) -
eval_a a = eval_a( pls, x ) -
eval_b b = eval_b( pls, x ) -
eval_b2p b = eval_b2p( pls, x ) -
eval_bprime b = eval_b( pls, x ) -
eval_z z = eval_z( pls, x ) -
find_null find_null, pls, x
fl_from_point fl = fl_from_point( pls, x0 ) max_segs; seg_size; dir;
fl_intgrt done = fl_intgrt( pls, x0 )
fl_view_xform fl_view_xform, fl, view -
gamma_line fl = gamma_line( pls, null ) -
init_sepx_line x = init_spex_line, pls, null, theta -
is_pole i = is_pole( pls, lab ) -
line_piece fl = line_piece( ofl, zmin=zmin, n=n ) ARGUUMENTS: ofl - the old field line
null_incidence_matrix mat = null_incidence_matrix( nls, spr ) count=count;
null_scan inds = null_scan( pls, null )
pole_of_theta i = pole_of_theta( pls, null, th_val ) -
random_field_line fl = random_field_line( pls ) -
relabel_nulls relabel_nulls, nls, [ pls ], [ keywords ] sequential; polar; sort;
relabel_poles relabel_poles, pls, sort;
sepr_line fl = sepr_line( pls, nulls, sepr ) -
sepr_plane result = sepr_plane( pls, nulls, sepr ) -
sepx_line fl = sepx_line( pls, null, theta )
tan_plane_matrix tpmat = tan_plane_matrix( lat, cmd ). matrix takes a tangent vector in disk coordinates [ vx, vy, vz ] = tmat # [ vw, vn, vr ] b = b; p = p;
update_nulls new_nulls = update_nulls( pls, nls ) -
view2time time = view2time( view ) days; from=datestr;

all_nulls

all_seprs

cm2csv

cm_list

connectivity

cribbon

current_solve

disk2tan_plane

dm2tex

dm_print

dm_schematic

domain_char

domain_matrix

fill_dmn_fp

index_check

inv_lam_func

latex_poles

line_info

mut_induct_mat

new_tan_plane

null_graph

pixel2tan_plane

pls_phi_hist

polka_map

rd_pns

sepr_info

show_3dnulls

show_3dpoles

show_connectivity

show_cr_skel

show_dm

show_domain

show_flux_tube

show_fp

show_gamma_lines

show_loop_skeleton

show_nulls

show_poles

show_random_3dlines

show_sepr

show_sepx

solar_rotate_view

sum_graph

tan_plane2disk

view_xform

voronoi_pls

write_pns

xadd_nulls

xselect_fl

xselect_null

advance_dif_rot

asym_fl_map

avg_bp

calc_sepr_info

clip_fl

closest_pole

create_null

create_pls

create_spr

eval_a

eval_b

eval_b2p

eval_bprime

eval_z

find_null

fl_from_point

fl_intgrt

fl_view_xform

gamma_line

init_sepx_line

is_pole

line_piece

null_incidence_matrix

null_scan

pole_of_theta

random_field_line

relabel_nulls

relabel_poles

sepr_line

sepr_plane

sepx_line

tan_plane_matrix

update_nulls

view2time