Skip to content

Commit

Permalink
run package document build updates
Browse files Browse the repository at this point in the history
  • Loading branch information
@xieguigang
xieguigang committed Jan 6, 2024
1 parent 5dd3162 commit e029cd2
Show file tree
Hide file tree
Showing 38 changed files with 1,512 additions and 1,792 deletions.
17 changes: 16 additions & 1 deletion @export/NRRD.d.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -49,7 +49,22 @@ declare namespace NRRD {
function nrrdRead(file: any, env?: object): object;
module write {
/**
* @param env default value Is ``null``.
* create a nrrd file based on a given collection of the image data objects.
*
* > the required **`rasters`** data collection element could be one of the:
* >
* > 1. the gdi+ @``T:System.Drawing.Image`` data object
* > 2. the @``T:Microsoft.VisualBasic.Imaging.Drawing2D.HeatMap.RasterMatrix`` for do heatmap rendering
* >
* > for a collection with only one ratser object inside, 2d nrrd object will be generates,
* > for a collection with multiple raster object inside, 3d nrrd object will be generates.
*
* @param file -
* @param rasters a collection of the image data objects. all of the raster object inside
* this given collection should be in the same dimension size!
* @param env -
*
* + default value Is ``null``.
*/
function nrrd(file: any, rasters: any, env?: object): any;
/**
Expand Down
4 changes: 2 additions & 2 deletions man/.onLoad.1
View file
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
.TH .ONLOAD 1 2023-Nov "" ".onLoad"
.TH .ONLOAD 1 2024-Jan "" ".onLoad"
.SH NAME
.onLoad \- .onLoad()
.SH SYNOPSIS
Expand All @@ -8,4 +8,4 @@
SMRUCC/R#.declare_function..onLoad at zzz.R:line 3
.PP
.SH COPYRIGHT
Copyright © xieguigang <[email protected]>, MIT License Licensed 2023
Copyright © xieguigang <[email protected]>, MIT License Licensed 2024
2 changes: 1 addition & 1 deletion man/DICOM/NRRD/NRRD.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -24,4 +24,4 @@
+ [as.pointCloud](NRRD/as.pointCloud.1)
+ [as.pointMatrix](NRRD/as.pointMatrix.1)
+ [write.ply](NRRD/write.ply.1) write the NRRD raster data to PLY point cloud model
+ [write.nrrd](NRRD/write.nrrd.1)
+ [write.nrrd](NRRD/write.nrrd.1) create a nrrd file based on a given collection of the image data objects.
27 changes: 26 additions & 1 deletion man/DICOM/NRRD/NRRD/write.nrrd.1
View file
Original file line number Diff line number Diff line change
@@ -1,11 +1,36 @@
.\" man page create by R# package system.
.TH NRRD 1 2000-Jan "write.nrrd" "write.nrrd"
.SH NAME
write.nrrd \-
write.nrrd \- create a nrrd file based on a given collection of the image data objects.
.SH SYNOPSIS
\fIwrite.nrrd(\fBfile\fR as any,
\fBrasters\fR as any,
[\fB<Environment>\fR]);\fR
.SH DESCRIPTION
.PP
create a nrrd file based on a given collection of the image data objects.
.PP
.SH OPTIONS
.PP
\fBfile\fB \fR\- -.
.PP
.PP
\fBrasters\fB \fR\- a collection of the image data objects. all of the raster object inside
this given collection should be in the same dimension size!.
.PP
.PP
\fBenv\fB \fR\- -.
.PP
.SH DETAILS
.PP
the required **`rasters`** data collection element could be one of the:

1. the gdi+ @\fBT:System.Drawing.Image\fR data object
2. the @\fBT:Microsoft.VisualBasic.Imaging.Drawing2D.HeatMap.RasterMatrix\fR for do heatmap rendering

for a collection with only one ratser object inside, 2d nrrd object will be generates,
for a collection with multiple raster object inside, 3d nrrd object will be generates.
.PP
.SH SEE ALSO
NRRD
.SH FILES
Expand Down
9 changes: 9 additions & 0 deletions vignettes/DICOM/LASer.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -73,7 +73,14 @@ <h1>LASer</h1>
</p>
</blockquote>
<div id="main-wrapper">
<table class="table-three-line" style="display: none">
<caption>.NET clr type export</caption>
<tbody></tbody>
</table>
<br />
<br />
<table class="table-three-line">
<caption>.NET clr function exports</caption>
<tbody><tr>
<td id="open">
<a href="./LASer/open.html">open</a>
Expand All @@ -100,5 +107,7 @@ <h1>LASer</h1>
</tr></tbody>
</table>
</div>
<hr />
<div style="text-align: center;">[<a href="../index.html">Document Index</a>]</div>
</body>
</html>
143 changes: 6 additions & 137 deletions vignettes/DICOM/LASer/as.las.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -5,142 +5,7 @@
<title>try to cast the raw raster object to las point cloud data</title>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0, user-scalable=yes" />
<style rel="stylesheet" type="text/css">
@media screen {
.container {
padding-right: 10px;
padding-left: 10px;
margin-right: auto;
margin-left: auto;
max-width: 900px;
}
}

.rimage img {
/* from knitr - for examples and demos */
width: 96%;
margin-left: 2%;
}

.katex {
font-size: 1.1em;
}

code {
color: rgb(194, 42, 42);
background: inherit;
font-style: italic;
font-weight: bold;
}

pre code {
color: rgb(54, 54, 54);
font-style: normal;
}

body {
line-height: 1.4;
background: white;
color: black;
}

a:link {
background: white;
color: blue;
}

a:visited {
background: white;
color: rgb(50%, 0%, 50%);
}

h1 {
background: white;
color: rgb(55%, 55%, 55%);
font-family: monospace;
font-size: 1.4em;
/* x-large; */
text-align: center;
}

h2 {
background: white;
color: rgb(40%, 40%, 40%);
font-family: monospace;
font-size: 1.2em;
/* large; */
text-align: center;
}

h3 {
background: white;
color: rgb(40%, 40%, 40%);
font-family: monospace;
font-size: 1.2em;
/* large; */
}

h4 {
background: white;
color: rgb(40%, 40%, 40%);
font-family: monospace;
font-style: italic;
font-size: 1.2em;
/* large; */
}

h5 {
background: white;
color: rgb(40%, 40%, 40%);
font-family: monospace;
}

h6 {
background: white;
color: rgb(40%, 40%, 40%);
font-family: monospace;
font-style: italic;
}

img.toplogo {
width: 4em;
vertical-align: middle;
}

img.arrow {
width: 30px;
height: 30px;
border: 0;
}

span.acronym {
font-size: small;
}

span.env {
font-family: monospace;
}

span.file {
font-family: monospace;
}

span.option {
font-family: monospace;
}

span.pkg {
font-weight: bold;
}

span.samp {
font-family: monospace;
}

div.vignettes a:hover {
background: rgb(85%, 85%, 85%);
}
</style>
<link rel="stylesheet" type="text/css" href="../../_assets/page.css">
</head>

<body>
Expand Down Expand Up @@ -186,7 +51,7 @@ <h3 style="display: none;">Details</h3>

<h3>Value</h3>

this function returns data object of type <a href="/clr/SMRUCC/DICOM/LASer/Model/LasPoint.html">LasPoint</a>.
this function returns data object of type <a href="/vignettes/clr/SMRUCC/DICOM/LASer/Model/LasPoint.html">LasPoint</a>.<h4>clr value class</h4><ul><li><a href="/vignettes/clr/SMRUCC/DICOM/LASer/Model/LasPoint.html">LasPoint</a></li></ul>

<h3 style="display: none;">Examples</h3>

Expand All @@ -199,4 +64,8 @@ <h3 style="display: none;">Examples</h3>
</div>
</body>

<script type="text/javascript" src="../../_assets/R_syntax.js"></script>
<script type="text/javascript" src="../../_assets/highlights.js"></script>
<script type="text/javascript">r_highlights("example_r");</script>

</html>
Loading

0 comments on commit e029cd2

Please sign in to comment.