Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/stdlib-js/simulate-iter-bartlett-hann-pulse
Create an iterator which generates a Bartlett-Hann pulse waveform.
https://github.com/stdlib-js/simulate-iter-bartlett-hann-pulse
bartlett cosine fejer hann javascript node node-js nodejs pulse raised raised-cosine signal simulate simulation stdlib train triangle triangular wave window
Last synced: about 18 hours ago
JSON representation
Create an iterator which generates a Bartlett-Hann pulse waveform.
- Host: GitHub
- URL: https://github.com/stdlib-js/simulate-iter-bartlett-hann-pulse
- Owner: stdlib-js
- License: apache-2.0
- Created: 2021-06-15T17:11:39.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2024-10-01T12:59:59.000Z (2 days ago)
- Last Synced: 2024-10-01T21:10:06.235Z (1 day ago)
- Topics: bartlett, cosine, fejer, hann, javascript, node, node-js, nodejs, pulse, raised, raised-cosine, signal, simulate, simulation, stdlib, train, triangle, triangular, wave, window
- Language: JavaScript
- Homepage: https://github.com/stdlib-js/stdlib
- Size: 1.36 MB
- Stars: 2
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
- Citation: CITATION.cff
- Security: SECURITY.md
Awesome Lists containing this project
README
About stdlib...
We believe in a future in which the web is a preferred environment for numerical computation. To help realize this future, we've built stdlib. stdlib is a standard library, with an emphasis on numerical and scientific computation, written in JavaScript (and C) for execution in browsers and in Node.js.
The library is fully decomposable, being architected in such a way that you can swap out and mix and match APIs and functionality to cater to your exact preferences and use cases.
When you use stdlib, you can be absolutely certain that you are using the most thorough, rigorous, well-written, studied, documented, tested, measured, and high-quality code out there.
To join us in bringing numerical computing to the web, get started by checking us out on GitHub, and please consider financially supporting stdlib. We greatly appreciate your continued support!
# iterBartlettHannPulse
[![NPM version][npm-image]][npm-url] [![Build Status][test-image]][test-url] [![Coverage Status][coverage-image]][coverage-url]
> Create an iterator which generates a Bartlett-Hann pulse waveform.
A Bartlett-Hann pulse waveform is represented by the following equation
```math
f(t; T, \tau, A, \varphi) = \begin{cases}A \biggl(0.62 - 0.48\biggl|\frac{t-\varphi}{\tau-1} - \frac{1}{2}\biggr| - 0.38\cos\frac{2\pi (t-\varphi)}{\tau-1}\biggr) & (t-\varphi) \mod T < \tau \\ 0 & \textrm{otherwise} \end{cases}
```
where `T` is the pulse period, `τ` is the pulse duration, `A` is the amplitude, and `φ` is the phase offset.
## Installation
```bash
npm install @stdlib/simulate-iter-bartlett-hann-pulse
```
Alternatively,
- To load the package in a website via a `script` tag without installation and bundlers, use the [ES Module][es-module] available on the [`esm`][esm-url] branch (see [README][esm-readme]).
- If you are using Deno, visit the [`deno`][deno-url] branch (see [README][deno-readme] for usage intructions).
- For use in Observable, or in browser/node environments, use the [Universal Module Definition (UMD)][umd] build available on the [`umd`][umd-url] branch (see [README][umd-readme]).
The [branches.md][branches-url] file summarizes the available branches and displays a diagram illustrating their relationships.
To view installation and usage instructions specific to each branch build, be sure to explicitly navigate to the respective README files on each branch, as linked to above.
## Usage
```javascript
var iterBartlettHannPulse = require( '@stdlib/simulate-iter-bartlett-hann-pulse' );
```
#### iterBartlettHannPulse( \[options] )
Returns an iterator which generates a Bartlett-Hann pulse waveform.
```javascript
var it = iterBartlettHannPulse();
// returns
var v = it.next().value;
// returns
v = it.next().value;
// returns
v = it.next().value;
// returns
// ...
```
The returned iterator protocol-compliant object has the following properties:
- **next**: function which returns an iterator protocol-compliant object containing the next iterated value (if one exists) assigned to a `value` property and a `done` property having a `boolean` value indicating whether the iterator is finished.
- **return**: function which closes an iterator and returns a single (optional) argument in an iterator protocol-compliant object.
The function supports the following `options`:
- **period**: pulse period (i.e., the number of iterations before a waveform repeats). Default: `100`.
- **duration**: pulse duration. Must be greater than `2`. Default: `options.period`.
- **amplitude**: amplitude. Default: `1.0`.
- **offset**: phase offset (in units of iterations; zero-based). A negative offset translates a waveform to the left. A positive offset translates a waveform to the right. Default: `0`.
- **iter**: number of iterations. Default: `1e308`.
By default, the function returns an iterator which generates a waveform that repeats every `100` iterations. To specify an alternative period, set the `period` option.
```javascript
var opts = {
'period': 10
};
var it = iterBartlettHannPulse( opts );
// returns
var v = it.next().value;
// returns
v = it.next().value;
// returns
// ...
```
By default, the function returns an iterator which generates a waveform that has a duty cycle of `100%` (i.e., the waveform duration equals the waveform period). To specify an alternative duty cycle, set the `duration` option. For example, to generate a waveform having a period of `10` iterations and a `50%` duty cycle,
```javascript
var opts = {
'period': 10,
'duration': 5 // 5/10 = 0.50 => 50%
};
var it = iterBartlettHannPulse( opts );
// returns
var v = it.next().value;
// returns
v = it.next().value;
// returns
v = it.next().value;
// returns
v = it.next().value;
// returns
v = it.next().value;
// returns
v = it.next().value;
// returns 0.0
v = it.next().value;
// returns 0.0
v = it.next().value;
// returns 0.0
v = it.next().value;
// returns 0.0
v = it.next().value;
// returns 0.0
// ...
```
To adjust at what point the iterator begins in the waveform cycle, set the phase `offset` option. For example, to translate the waveform to the left,
```javascript
var opts = {
'period': 10,
'duration': 5,
'offset': -7
};
var it = iterBartlettHannPulse( opts );
// returns
var v = it.next().value;
// returns 0.0
v = it.next().value;
// returns 0.0
v = it.next().value;
// returns 0.0
v = it.next().value;
// returns
v = it.next().value;
// returns
v = it.next().value;
// returns
// ...
```
To translate the waveform to the right,
```javascript
var opts = {
'period': 10,
'duration': 5,
'offset': 2
};
var it = iterBartlettHannPulse( opts );
// returns
var v = it.next().value;
// returns 0.0
v = it.next().value;
// returns 0.0
v = it.next().value;
// returns
v = it.next().value;
// returns
v = it.next().value;
// returns
// ...
```
By default, the function returns an infinite iterator (i.e., an iterator which never ends). To limit the number of iterations, set the `iter` option.
```javascript
var opts = {
'iter': 2
};
var it = iterBartlettHannPulse( opts );
// returns
var v = it.next().value;
// returns
v = it.next().value;
// returns
var bool = it.next().done;
// returns true
```
## Notes
- If an environment supports `Symbol.iterator`, the returned iterator is iterable.
## Examples
```javascript
var iterBartlettHannPulse = require( '@stdlib/simulate-iter-bartlett-hann-pulse' );
// Create an iterator:
var opts = {
'period': 50,
'duration': 25,
'amplitude': 10.0,
'offset': -25,
'iter': 100
};
var it = iterBartlettHannPulse( opts );
// Perform manual iteration...
var v;
while ( true ) {
v = it.next();
if ( v.done ) {
break;
}
console.log( v.value );
}
```
* * *
## See Also
- [`@stdlib/simulate-iter/bartlett-pulse`][@stdlib/simulate/iter/bartlett-pulse]: create an iterator which generates a Bartlett pulse waveform.
- [`@stdlib/simulate-iter/hann-pulse`][@stdlib/simulate/iter/hann-pulse]: create an iterator which generates a Hann pulse waveform.
- [`@stdlib/simulate-iter/pulse`][@stdlib/simulate/iter/pulse]: create an iterator which generates a pulse waveform.
- [`@stdlib/simulate-iter/triangle-wave`][@stdlib/simulate/iter/triangle-wave]: create an iterator which generates a triangle wave.
* * *
## Notice
This package is part of [stdlib][stdlib], a standard library for JavaScript and Node.js, with an emphasis on numerical and scientific computing. The library provides a collection of robust, high performance libraries for mathematics, statistics, streams, utilities, and more.
For more information on the project, filing bug reports and feature requests, and guidance on how to develop [stdlib][stdlib], see the main project [repository][stdlib].
#### Community
[![Chat][chat-image]][chat-url]
---
## License
See [LICENSE][stdlib-license].
## Copyright
Copyright © 2016-2024. The Stdlib [Authors][stdlib-authors].
[npm-image]: http://img.shields.io/npm/v/@stdlib/simulate-iter-bartlett-hann-pulse.svg
[npm-url]: https://npmjs.org/package/@stdlib/simulate-iter-bartlett-hann-pulse
[test-image]: https://github.com/stdlib-js/simulate-iter-bartlett-hann-pulse/actions/workflows/test.yml/badge.svg?branch=main
[test-url]: https://github.com/stdlib-js/simulate-iter-bartlett-hann-pulse/actions/workflows/test.yml?query=branch:main
[coverage-image]: https://img.shields.io/codecov/c/github/stdlib-js/simulate-iter-bartlett-hann-pulse/main.svg
[coverage-url]: https://codecov.io/github/stdlib-js/simulate-iter-bartlett-hann-pulse?branch=main
[chat-image]: https://img.shields.io/gitter/room/stdlib-js/stdlib.svg
[chat-url]: https://app.gitter.im/#/room/#stdlib-js_stdlib:gitter.im
[stdlib]: https://github.com/stdlib-js/stdlib
[stdlib-authors]: https://github.com/stdlib-js/stdlib/graphs/contributors
[umd]: https://github.com/umdjs/umd
[es-module]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Modules
[deno-url]: https://github.com/stdlib-js/simulate-iter-bartlett-hann-pulse/tree/deno
[deno-readme]: https://github.com/stdlib-js/simulate-iter-bartlett-hann-pulse/blob/deno/README.md
[umd-url]: https://github.com/stdlib-js/simulate-iter-bartlett-hann-pulse/tree/umd
[umd-readme]: https://github.com/stdlib-js/simulate-iter-bartlett-hann-pulse/blob/umd/README.md
[esm-url]: https://github.com/stdlib-js/simulate-iter-bartlett-hann-pulse/tree/esm
[esm-readme]: https://github.com/stdlib-js/simulate-iter-bartlett-hann-pulse/blob/esm/README.md
[branches-url]: https://github.com/stdlib-js/simulate-iter-bartlett-hann-pulse/blob/main/branches.md
[stdlib-license]: https://raw.githubusercontent.com/stdlib-js/simulate-iter-bartlett-hann-pulse/main/LICENSE
[@stdlib/simulate/iter/bartlett-pulse]: https://github.com/stdlib-js/simulate-iter-bartlett-pulse
[@stdlib/simulate/iter/hann-pulse]: https://github.com/stdlib-js/simulate-iter-hann-pulse
[@stdlib/simulate/iter/pulse]: https://github.com/stdlib-js/simulate-iter-pulse
[@stdlib/simulate/iter/triangle-wave]: https://github.com/stdlib-js/simulate-iter-triangle-wave